A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

Running the app

# 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

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.

Instructions

• Place the .dev.env file in the root folder of the project.
• Fill with your own variables.
• Create the database you will use.

Routes

• Create project - /projects (POST request)

  • Takes status, title, details, deadline and file form data fields

• All projects (including filtering capabilities using query parameter) - /projects?search=topic (GET request)

• Update project - /projects/:id (PATCH request)

  • Takes status, title, price, details, deadline, assigneeId and file form data fields

• Delete project - /projects/:id (DELETE request)

• Retrieve project file - /projects/project-files/:file-name (GET request)

• Project submission - /projects/:id/submit (PATCH request)

  • Takes submitText and file form data fields

• Sign up - /auth/sign-up (POST request)

  • Takes a username and password form data fields
  • username must be more than 4 letters
  • password must be more than 8, must have at least one uppercase letter, number and special character.
  • new user must be confirmed before access to the system is allowed

• Sign in - /auth/sign-in (POST request)

  • Takes a username and password form data fields
  • username must be more than 4 letters
  • password must be more than 8, must have at least one uppercase letter, number and special character.
  • returns accessToken string

• Retrieve all users (including filtering capabilities using query parameter) - /users?search=kofi (GET request)

NB: Create project, Update project and Project submission routes can take a file called file.