Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 3.44 KB

README.md

File metadata and controls

75 lines (53 loc) · 3.44 KB

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 project is built using the Nest framework, a progressive Node.js framework for building efficient and scalable server-side applications. It leverages TypeScript for type safety and modern JavaScript features.

Tech Stack

  • NestJS: A progressive Node.js framework for building efficient and scalable server-side applications.
  • TypeScript: A statically typed superset of JavaScript that compiles to plain JavaScript.
  • Prisma: A next-generation ORM for Node.js and TypeScript.
  • PostgreSQL: A powerful, open-source object-relational database system.

Installation

$ yarn install

Running Tests

To run the end-to-end tests, use the following command:

$ yarn test:e2e

Docker Setup

To set up the application using Docker, follow these steps:

  1. Ensure Docker is installed and running on your machine.
  2. Build and start the Docker containers:
$ docker compose up -d
  1. Verify that the containers are running:
$ docker ps

Environment Variables

Ensure you have the correct environment variables set up in your .env files. For example:

DATABASE_URL=postgresql://user:password@localhost:5434/nest-api?schema=public

License

Nest is MIT licensed.