/auction-system

Primary LanguageTypeScript

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

Description

This is a minimal auction system. This system allows users to do the following:

  • create an account
  • login
  • create an item
  • publish an item (that will be available for bidding)
  • bid on an item

For a more concise description of this system's api, please check the section on Documentation.

Installation

$ npm install

Config

# JWT CONFIG
JWT_SECRET = <Your JWT secret>
JWT_MAXIMUM_AGE = < JWT token life >

# MONGODB CONFIG
MONGO_USERNAME = <Username of a user in the database>
MONGO_PASSWORD = <Password of the user>
MONGO_HOST = <Host provided by MongoDB Atlas or private host>
MONGO_URI=mongodb+srv://${MONGO_USERNAME}:${MONGO_PASSWORD}@${MONGO_HOST}/?retryWrites=true&w=majority

# Note: if you don't use MongoDB Atlas, you will use another MONGO_URI format.

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

Documentation

Documentation in this project is generated using Swagger. Please make sure to install the application and then run :

$ npm run start

To consult Swagger documentation, simply open this url on your browser: http://localhost:3000/api.

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

License

Nest is MIT licensed.