https://github.com/agodin3z/nest-prisma-template
Prisma 2 + NestJS template
https://github.com/agodin3z/nest-prisma-template
nestjs prisma2
Last synced: 7 months ago
JSON representation
Prisma 2 + NestJS template
- Host: GitHub
- URL: https://github.com/agodin3z/nest-prisma-template
- Owner: agodin3z
- License: mit
- Created: 2023-06-04T18:16:17.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-26T17:52:41.000Z (12 months ago)
- Last Synced: 2024-10-26T19:43:48.683Z (12 months ago)
- Topics: nestjs, prisma2
- Language: TypeScript
- Homepage:
- Size: 2.36 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Prisma + NestJS API template
[](https://conventionalcommits.org)
[](https://github.com/prettier/prettier)
## Tech Stack
- [NestJS](https://nestjs.com/) - A progressive Node.js framework for building efficient, reliable and scalable server-side applications.
- [Prisma](https://www.prisma.io/) - Next-generation Node.js and TypeScript ORM.
- [Jest](https://jestjs.io/) - Delightful JavaScript Testing Framework with a focus on simplicity.
- [Husky](https://typicode.github.io/husky/) - Git hooks made easy dog woof!
- [ESLint](https://eslint.org/) - Find and fix problems in your JavaScript code.
- [Prettier](https://prettier.io/) - An opinionated code formatter.
- [Lint Staged](https://github.com/okonet/lint-staged) - Run linters on git staged files.
- [CommitLint](https://commitlint.js.org/) - Lint commit messages.
## Prerequisites
- [Volta](https://volta.sh/)* (node, npm, and yarn version manager)
> \* Optional dependency, alternatives: [n](https://github.com/tj/n) or [nvm](https://github.com/nvm-sh/nvm)
### Optional Development Prerequisites
Install the following dependencies:
- [Docker Desktop](https://docs.docker.com/desktop/) (An one-click-install application that enables you to build and share containerized applications and microservices.)
- [Docker Compose](https://docs.docker.com/compose/install/) (Plugin for running multi-container Docker applications)
Then create a `docker.env` file with the following values:
```env
MYSQL_ALLOW_EMPTY_PASSWORD=yes
MYSQL_USER=my_user
MYSQL_PASSWORD=my_secret_passwd
MYSQL_ROOT_PASSWORD=my_ultra_secret_passwd
MYSQL_DATABASE=my_db_name
```
## Getting Started
### Enviroment config
Create a copy of `.env.example` with the name `.env` and `.env.test.example` with the name `.env.test` and placed it at the root of the project
```bash
cp .env.example .env
cp .env.test.example .env.test
```
Replace its values with your own credentials.
### Install Dependencies
Run the following commands to install all dependencies:
```bash
volta install node
volta install yarn
yarn
```
### Create DB logic
Run the following commands to create and populate the databases:
```bash
yarn prisma:migrate:run
yarn prisma:migrate:run:test
yarn prisma:generate
yarn prisma:seed
```
## Development server
Run `yarn start:dev` to start a development server that watch for changes. For a debug server use: `yarn start:debug`
## Generate Prisma artifacts
Always run `yarn prisma:generate` after any change to `scheme.prisma`.
## Running unit tests
Run `yarn test` to execute the unit tests via [Jest](https://jestjs.io/). For coverage test use: `yarn test:cov`
## Build for production
Run `yarn build` to compile for production, this will execute `prebuild` and `postbuild` commands automatically. Then run `yarn start:prod` to start a production server.
## Scripts API Reference
### Server
| Script | Description |
| :----------------- | :---------------------------------------- |
| `yarn start` | Start server (without watch) |
| `yarn start:dev` | Start development server |
| `yarn start:debug` | Start debug development server |
| `yarn start:prod` | Start production server |
| `yarn pm2` | Run production server as Cluster with PM2 |
| `yarn pm2:restart` | Reload API with PM2 |
| `yarn pm2:stop` | Stop PM2 service |
| `yarn pm2:logs` | View PM2 logs |
### Build
| Script | Description |
| :-------------- | :---------------- |
| `yarn prebuild` | Clean dist folder |
| `yarn build` | Build project |
### Lint & Format
| Script | Description |
| :------------ | :------------------------- |
| `yarn format` | Format files with Prettier |
| `yarn lint` | Lint files with ESLint |
### Tests
| Script | Description |
| :---------------- | :----------------------- |
| `yarn test` | Run test (without watch) |
| `yarn test:watch` | Run test and watch |
| `yarn test:cov` | Run coverage test |
| `yarn test:e2e` | Run end-to-end tests |
| `yarn test:debug` | Debug tests |
### Prisma
| Script | Description |
| :------------------------------- | :-------------------------------------------------------------------------------------------- |
| `yarn prisma:migrate:save` | Creates a new migration based on the changes in the schema but does not apply that migration. |
| `yarn prisma:migrate:run` | Applies all pending migrations, and creates the database if it does not exist. |
| `yarn prisma:migrate:run:test` | Run migrations for test |
| `yarn prisma:migrate:reset` | Reset development DB |
| `yarn prisma:migrate:reset:test` | Reset test DB |
| `yarn prisma:generate` | Generate Prisma Client (artifacts) |
| `yarn prisma:seed` | Polulate DB with seed data |
| `yarn prisma:format` | Format your schema |
> For more information on Prisma, read the [official documentation](https://www.prisma.io/docs/reference/api-reference/command-reference/#migrate-dev)
### Misc
| Script | Description |
| :--------------------- | :--------------------------------------------------------------------- |
| `docker-compose up -d` | Builds, (re)creates, starts, and attaches to containers for a service. |