https://github.com/simform-solutions/nestjs-starter
https://github.com/simform-solutions/nestjs-starter
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/simform-solutions/nestjs-starter
- Owner: simform-solutions
- License: mit
- Created: 2023-08-22T11:37:11.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-12T09:32:35.000Z (over 2 years ago)
- Last Synced: 2025-01-20T09:29:56.447Z (about 1 year ago)
- Language: TypeScript
- Size: 773 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
## Installation
```bash
$ npm install
```
## Running the Server
```bash
# development
$ npm run dev
# production
$ npm run start
```
## Running services on Docker
```bash
docker-compose up
```
## Build
```bash
npm run build
```
## Tests
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
# run tests in local
$ npm run test:local
# run e2e tests in local
$ npm run test:local-e2e
```
## Run Database commands using Nesjs Console
```bash
# will list down all commands related with database.
$ npm run console:dev db
```
## Swagger Documentation
- Swagger documentation endpoint will be running at `/api` .
## K8s Deployment Local
```bash
# first start minikube
minikube start
# deployment
kubectl apply -f k8s/
# get endpoint of k8s cluster
minikube service nestjs-starter-service
```
## Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
## License
Nest is [MIT licensed](LICENSE).