https://github.com/fuerback/nestjs-api
A simple NestJS REST API with Authorization
https://github.com/fuerback/nestjs-api
authorization docker docker-compose environment-variables logging nestjs swagger typeorm typescript unit-testing
Last synced: 5 months ago
JSON representation
A simple NestJS REST API with Authorization
- Host: GitHub
- URL: https://github.com/fuerback/nestjs-api
- Owner: Fuerback
- Created: 2023-07-06T12:25:34.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T13:30:12.000Z (almost 3 years ago)
- Last Synced: 2024-01-26T10:10:40.364Z (over 2 years ago)
- Topics: authorization, docker, docker-compose, environment-variables, logging, nestjs, swagger, typeorm, typescript, unit-testing
- Language: TypeScript
- Homepage:
- Size: 145 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Task Manager REST API
## Description
A simple project for managing tasks using Nest as a web framework.
## Installation
Add the environments below to `.env` or export in your favorite bash file.
| Name | Value |
|-------------------|---------------------|
| PG_CONTAINER_NAME | postgres_task |
| POSTGRES_USER | tasks_admin |
| POSTGRES_PASSWORD | admingres |
| POSTGRES_DB | taskmanagement |
| PGDATA | /data/postgres-task |
| PG_HOST | db |
| PG_PORT | 5432 |
| APP_PORT | 3000 |
```bash
$ npm install
```
## Running the app
```bash
$ docker-compose up -d
```
## Endpoints
OpenAPI documentation [here](./swagger-api.yaml)
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## TO-DO
- [ ] Add more unit tests
- [ ] Add integration tests
- [ ] Add more logs
- [ ] Add Redis
- [x] Add Swagger documentation
## License
Nest is [MIT licensed](LICENSE).