A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest framework TypeScript starter repository.

---

Getting Started

Prerequisites

• Node.js (v18+ recommended)
• Docker

---

Running the Project

1. Clone the repository

git clone https://github.com/thetreeorg/tree-auth-backend.git
cd tree-auth-backend

2. Start PostgreSQL with Docker

This project uses PostgreSQL as its database. You can start a local instance using Docker Compose:

docker-compose up -d

This will start a PostgreSQL server on port 5432 with default credentials:

• Database: treeauth
• User: postgres
• Password: postgres

3. Configure Environment Variables

Create a .env file in the root directory with the following content:

DATABASE_URL="postgresql://postgres:postgres@localhost:5432/treeauth"

You can adjust the values as needed.

4. Install dependencies

npm install

5. Generate Prisma Client & Run Migrations

npx prisma generate
npx prisma migrate dev

6. Start the Application

# development
npm run start

# watch mode
npm run start:dev

# production mode
npm run build
npm run start:prod

---

Running Tests

# unit tests
npm run test

# e2e tests
npm run test:e2e

# test coverage
npm run test:cov

---

Useful Commands

• Stop Docker containers:

  docker-compose down

• View database in Prisma Studio:

  npx prisma studio

---

Deployment

Project setup

$ npm install

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ npm install -g @nestjs/mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

• Visit the NestJS Documentation to learn more about the framework.
• For questions and support, please visit our Discord channel.
• To dive deeper and get more hands-on experience, check out our official video courses.
• Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
• Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
• Need help with your project (part-time to full-time)? Check out our official enterprise support.
• To stay in the loop and get updates, follow us on X and LinkedIn.
• Looking for a job, or have a job to offer? Check out our official Jobs board.

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.