Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thirdmadman/nodejs2023q2-service
https://github.com/thirdmadman/nodejs2023q2-service
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thirdmadman/nodejs2023q2-service
- Owner: thirdmadman
- Created: 2023-07-25T15:46:14.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-22T17:49:43.000Z (about 2 months ago)
- Last Synced: 2024-11-22T18:40:42.439Z (about 2 months ago)
- Language: TypeScript
- Size: 602 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Home Library Service
## Prerequisites
- Git - [Download & Install Git](https://git-scm.com/downloads).
- Node.js v 18 or higher - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.
- Docker **
- PostgreSQL Server **
** Conditional, depending on your desired method of run app.
## Documentation
You can find the documentation in the /docs directory.
Also after installing and starting the app, Swagger will active on the /api route.
After starting the app on port (4000 as default) you can open
in your browser OpenAPI documentation by typing .
For more information about OpenAPI/Swagger please visit .
## Downloading
``` cli
git clone {repository URL}
```
## Installing NPM modules
``` cli
npm install
```
## Configuring .env
Rename existing ```.env.example``` to ```.env```
Correct configuration to your preferences. If on ```.env``` file is provided, then default configuration will be used.
## Running application
## Local run
Before starting the app you need to run postgresql on your machine, it could be a stand-alone version or docker container, or even a remote server.
Put you connection data in .env file.
Before starting app you will need start
``` cli
npx prisma generate
npx prisma migrate deploy
```
To generate prisma client and push migration to DB.
You can start the application in dev or prod mode by running
``` cli
npm run start:dev
```
or
``` cli
npm run start:prod
```
## Docker run
You can run the application in docker containers for development mode and also in production.
### Docker run in development mode
In between switching production and development mode, it should be used clean up command (this will ensure that that all corresponding containers/volumes are down):
``` cli
docker compose -f docker-compose.dev.yaml down --rmi local --volumes
```
To run app by docker in dev mode run this command.
``` cli
docker compose -f docker-compose.dev.yaml up --detach --build --force-recreate
```
This command will start build and then run containers.
Postgres container will start with connection data which is stored in .env file and exposed ports.
App container after start will copy all files (excluding some from .dockerignore) to container then install all packages from ```package-lock.json``` and then generate prisma client and stop in "install" stage.
After build docker compose will send commends to container:
```npx prisma migrate deploy``` - this will start the prisma migration on fresh DB.
```npm run start:dev``` - this will start the nestjs app in watch mode.
After container started you are free to edit you app files in src directory in you local machine, docker container will receive all changes and rebuild app.
This command will stop containers:
``` cli
docker compose -f docker-compose.dev.yaml stop
```
### Docker run in production mode
In between switching production and development mode, it should be used clean up command (this will ensure that that all corresponding containers/volumes are down):
``` cli
docker compose -f docker-compose.yaml down --rmi local --volumes
```
To run app by docker in production mode run this command.
``` cli
docker compose -f docker-compose.yaml up --detach --build --force-recreate
```
This command will start build and then run containers.
Postgres container will start with connection data which is stored in .env file.
App container after start will copy all files (excluding some from .dockerignore) to container then install all packages from ```package-lock.json``` and then generate prisma client and stop in "install" stage.
Then in stage build app will be builded.
Then in "production" stage, result of build will be copied and set ownership to "node" user. NODE_ENV will be set to production and ```npm prune --production``` will be started to remove all dev dependencies. This step will decrease size of container.
After build docker compose will send commends to container:
```npx prisma migrate deploy``` - this will start the prisma migration on fresh DB.
```npm run start:prod``` - this will start the nestjs app in prod mode.
After container started only app container will be exposed to the world on port used in .env file.
``` cli
docker compose -f docker-compose.yaml stop
```
## Vulnerabilities scanning
You can scan images and npm packages for vulnerabilities with command ```npm run scan:dev``` or ```npm run scan:prod```
Depending on current docker composer run you need to run corresponding command.
```npm run scan:dev``` - for ```docker-compose.dev.yaml```
```npm run scan:prod``` - for ```docker-compose.yaml```
## Testing
After application running open new terminal and enter:
To run all tests without authorization
``` cli
npm run test
```
To run only one of all test suites
``` cli
npm run test --
```
To run all test with authorization
``` cli
npm run test:auth
```
To run only specific test suite with authorization
``` cli
npm run test:auth --
```
### Auto-fix and format
``` cli
npm run lint
```
``` cli
npm run format
```
### Debugging in VSCode
Press F5 to debug.
For more information, visit: