A simple template to get started with Nest which just meets my need. Feel free to fork and open a pull request if you would like to put something into in.

Description

This boilerplate aims to bring a simple nest application setup with all the support which a developer aims to get in an application to start. Please do note that this is just a reflection of how I like to have my application with all the utils and other things, If you know, you know.

I am not aiming yet to bring the test feature into this application since it varies in many cases, and you should write your test as per yourself. It's something important but yeah not yet on my To-Do. Sooner or later, it will be there anyway.

Installation

npm install

Running the app manually

# development
$ npm run start

# watch mode
$ npm run start:dev

# using docker
$ docker-compose up

# production mode
$ npm run start:prod

Running the app using docker image

1. Make docker-compose.yml file.
2. Add the following contents into it -

version: '3.9'
services:
    api:
        image: ghcr.io/r-priyam/nestjs-boilerplate:latest
        container_name: My-Cute-API
        env_file:
            - .env

3. Make .env file in same directory where docker-compose.yml file is. Sample env file can be found here
4. All set, run docker-compose up from CLI and application will start up.

• Please note, by default docker will assign your current directory name to project name while running docker-compose up command. To provide a name for your prject add COMPOSE_PROJECT_NAME=Your-Project-Name variable in .env file. Read more about compose enviroments here.

Contributing

1. Fork the repo!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D