https://github.com/0-vortex/nestjs-documents-api
nestjs example for document editing
https://github.com/0-vortex/nestjs-documents-api
Last synced: 9 months ago
JSON representation
nestjs example for document editing
- Host: GitHub
- URL: https://github.com/0-vortex/nestjs-documents-api
- Owner: 0-vortex
- License: mit
- Created: 2023-12-06T08:22:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-11T16:48:25.000Z (over 2 years ago)
- Last Synced: 2024-12-30T01:34:47.983Z (over 1 year ago)
- Language: TypeScript
- Size: 164 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
## Local development
```shell
# start the database containers
docker compose up --remove-orphans -d
```
Navigate to
- [localhost:3001/swagger](http://localhost:3001/swagger) for API docs
- [localhost:8888](http://localhost:8888) for pgAdmin
- [localhost:8889](http://localhost:8889) for pev2
## Description
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository with strategies:
- @nestjs/config
- @nestjs/platform-fastify
- @nestjs/swagger
- @nestjs/terminus
- @nestjs/typeorm
- nestjs-pino
## Tooling
- @darraghor/eslint-plugin-nestjs-typed
- @tmcb/check-engines
- @tmcb/conventional-commit
- typesync
## CI/CD
- docker
- @tmcb/release
## Installation
```shell
npm ci
```
## Running the app
```shell
# development
npm start
# watch mode
npm run start:dev
# production mode
npm run start:prod
```
## Test
```shell
# unit tests
npm test
# e2e tests
npm run test:e2e
# test coverage
npm run test:cov
```
## License
Nest is [MIT licensed](LICENSE).