Skip to content

Latest commit

 

History

History
92 lines (66 loc) · 3.87 KB

README.md

File metadata and controls

92 lines (66 loc) · 3.87 KB

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 the server side for the Akkor project. The goal here is mimic a hotel room booking plateform. You have access to CRUD operations for hotels, users and reservations.

For this project, you'll need:

  • A mongoose cluster setup
  • A AWS S3 bucket to store hotels images

To make this server work please create a .env file in the root file of the project. Inside of it create variables:

-DB_URI -PORT -JWT_SECRET -BUCKET_NAME -AWS_SECRET_ACCESS_KEY -AWS_REGION -AWS_ACCESS_KEY_ID

To populate your mongoose db with 15 hotels, please run the seed file found in the src folder of the project. You need to provide you own images and name them like so image1.jpeg -> image30.jpeg

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

License

Nest is MIT licensed.