Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 1.36 KB

README.md

File metadata and controls

64 lines (44 loc) · 1.36 KB

Tasks

Description

The backend repo of tasks

an application for task management for teams

  • A User can create account with username, email, password
  • A User can login via username and password, requests after that is authenticated via JWT
  • A User can create workspace/s and add other users to or remove them from the workspace he created\
  • only the creator of the workspace can add or remove users
  • users in the workspace can post tasks in the workspace
  • only users in the workspace can view the tasks in that workspace
  • users in workspace assign it to one or more users in the same workspace
  • workspace creator or task poster can edit the task
  • workspace creator or task poster can delete the task
  • each workspace has a chat room (only users in the workspace can send messages)
  • various types of files can be sent in the chat room

Installation

$ npm install

Running the app

creating the postgres database for development

docker-compose up db -d
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Swagger (OpenAPI)

you can access the swagger API schema through the endpoint (dev mode)

localhost:8000/api