VEZHA

Description

Vezha - project manager app server!

Documentation for endpoints API

Doc localhost:4000/doc - detailed documentation

Home localhost:4000 - home page, check if the server is running

• localhost:4000/login - authorization

  • POST login - get token

• localhost:4000/users - requires authorization(header: authorization Bearer token)

  • POST users - add user
  • GET users - get all users
  • GET users/:id - get user by id
  • PUT users/:id - update user by id
  • DELETE users/:id - delete user by id

• localhost:4000/boards - requires authorization(header: authorization Bearer token)

  • POST boards - add board
  • GET boards - get all boards
  • GET boards/:id - get board by id
  • PUT boards/:id - update board by id
  • DELETE boards/:id - delete board by id

• localhost:4000/boards/:boardId/tasks - requires authorization(header: authorization Bearer token)

  • POST tasks - add task
  • GET tasks - get all tasks
  • GET tasks/:id - get task by id
  • PUT tasks/:id - update task by id
  • DELETE tasks/:id - delete task by id

• localhost:4000/boards/:boardId/columns - requires authorization(header: authorization Bearer token)

  • POST columns - add column
  • GET columns - get all columns
  • GET columns/:id - get column by id
  • PUT columns/:id - update column by id
  • DELETE columns/:id - delete column by id

• localhost:4000/file - key: file, value: upload file

  • POST file - add file(requires authorization(header: authorization Bearer token))
  • GET file/:fileName - get file by name

Prerequisites

• Git - Download & Install Git.
• Node.js - Download & Install Node.js and the npm package manager.

Downloading

git clone https://github.com/GoldenManBel/Vezha_BackEnd.git

Installing NPM modules

npm ci

Running application in docker

docker compose up --build

# e2e tests
npm run test:auth

or

docker exec -i -t app sh

# e2e tests
npm run test:auth

Running application local and bd in docker

docker build -t postgres database. 

docker run -dp 5432:5432 --rm -e POSTGRES_HOST_AUTH_METHOD=trust postgres

# watch mode
npm run start:dev 

# e2e tests
npm run test:auth

Migrations generate

npm run migration:generate

Auto-fix and format

npm run lint

Debugging in VSCode

Press F5 to debug.

For more information, visit: https://code.visualstudio.com/docs/editor/debugging

Performance tests

There are also files in the artillery folder with additional information

Express

Fastify