installing-and-running.md

Installation

---

Table of Contents

• Comfortable development
• Quick run
• Links

---

Comfortable development

1. Clone repository

   git clone --depth 1 https://github.com/brocoders/nestjs-boilerplate.git my-app

2. Go to folder, and copy env-example as .env.

   cd my-app/
   cp env-example .env

3. Change DATABASE_HOST=postgres to DATABASE_HOST=localhost

   Change MAIL_HOST=maildev to MAIL_HOST=localhost

4. Run additional container:

   docker compose up -d postgres adminer maildev

5. Install dependency

   npm install

6. Run migrations

   npm run migration:run

7. Run seeds

   npm run seed:run

8. Run app in dev mode

   npm run start:dev

9. Open http://localhost:3000

---

Quick run

If you want quick run your app, you can use following commands:

1. Clone repository

   git clone --depth 1 https://github.com/brocoders/nestjs-boilerplate.git my-app

2. Go to folder, and copy env-example as .env.

   cd my-app/
   cp env-example .env

3. Run containers

   docker compose up -d

4. For check status run

   docker compose logs

5. Open http://localhost:3000

Video guideline

nestjs-boilerplate-installation.mp4

---

Links

• Swagger (API docs): http://localhost:3000/docs
• Adminer (client for DB): http://localhost:8080
• Maildev: http://localhost:1080

---

Previous: Introduction

Next: Working with database