Skip to content

Repository files navigation

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 Nest backend application. You can find the frontend here. This application handles calls to the omdb api, stores user information, and tracks movie and favorites information.

Installation

$ npm install

Getting Started

Setup local development environment

Copy the .env.example file and name it .env. Next, add an missing values in .env. The run one of the following scripts before.

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Docker (Currently unavailable)

First, make sure you have docker installed.

  • Clone the repository to your local
  • Copy the .env.example to .env and configure the environment variables
  • Run the following command from your application root directory
docker-compose build
docker-compose up

or (run as deamon)

docker-compose up -d

If you need to rebuild the container:

docker-compose up --build

To stop all containers:

docker-compose stop

To stop a specific container:

docker-compose stop <container name>
e.g. docker-compose stop app

To start a specific container:

docker-compose up <container name>
e.g. docker-compose up app

Swagger documentation

This application uses swagger to map out the endpoints of the application. To see the documentation, run the application, and visit localhost:4000/swagger in your browser.

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.

License

Nest is MIT licensed.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages