Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bryopsida/nestjs-starter
A Nest.JS starter for a REST API with image and helm chart.
https://github.com/bryopsida/nestjs-starter
container-image helm nestjs nodejs rest-api starter-template typescript
Last synced: about 1 month ago
JSON representation
A Nest.JS starter for a REST API with image and helm chart.
- Host: GitHub
- URL: https://github.com/bryopsida/nestjs-starter
- Owner: bryopsida
- License: mit
- Created: 2023-06-17T19:31:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-11T13:14:49.000Z (about 2 months ago)
- Last Synced: 2024-12-11T14:23:12.579Z (about 2 months ago)
- Topics: container-image, helm, nestjs, nodejs, rest-api, starter-template, typescript
- Language: TypeScript
- Homepage:
- Size: 1.11 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nest.JS Starter Template
## What's Included
- OpenAPI/Swagger
- Health EP `/health`
- Helmet
- Dockerfile
- Helm Chart
- GitHub Action workflows to lint, test, build image, and verify helm chart
## NPM Scripts
| Syntax | Description |
| ------------------ | ------------------------------------------------------------------- |
| minikube:start | Creates a minikube cluster for testing |
| minikube:stop | Stops the minikube cluster |
| minikube:delete | Deletes the minikube cluster |
| minikube:copyImage | Load the build image from build:image into the minikube cluster |
| build | Compile the TypeScript to JavaScript |
| build:image | Build the container image |
| build:docs | Builds the docs folder |
| start:dev | Run the server with hot reloading on save |
| start | Start the server |
| lint | Check if code passes linting rules |
| lint:fix | Automatically fix any formatting or linting rules that can be fixed |
| helm:deploy | Deploy the chart with the local to your cluster |
| helm:uninstall | Delete the chart release from your cluster |
| helm:test | Run the packaged tests (postman) for the helm release |
| test | Run the unit tests |
## How to use published chart
First add the repo `helm repo add nestjs-starter https://bryopsida.github.io/nestjs-starter/`, then fetch updates `helm repo update`, and finally, install with `helm upgrade --install starter nestjs-starter/nestjs-starter --wait`.