nicolas-E1/ilovecoffee

NestJS small REST API app

I-Love-Coffee

A project from the NestJS Foundamentals official course.

Requirements

• Node.js v12.0.0 or later
• yarn or npm (Node Package Manager)
• Docker
• Nest CLI

Getting Started

1. Clone the repo in your machine.

git clone https://github.com/nicolasbracigliano/ilovecoffee.git

2. Install the dependencies.

$ yarn install

3. Create a .env file in the root of the project with the following environment variables.

DATABASE_USER=<db_user>
DATABASE_PASSWORD=<db_password>
DATABASE_NAME=<db_name>
DATABASE_PORT=<db_port>
DATABASE_HOST=<db_host>

Running the app

1. Spin the DB using docker

docker compose up db -d

2. Start the development server in watch mode.

yarn run start:dev

3. Visit http://localhost:3000/ to access the running application.

4. Use the Postman Collection to interact with the API.

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

Navigating the code

The project is structured such that each chapter has its own branch. This allows for easy access to the chapter of interest and retrieval of the final chapter code. Moreover, every topic within a chapter is accompanied by a corresponding commit.

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.