Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hmake98/nestjs-starter

🚀 NestJS starter boilerplate with Basic Authentication, Swagger docs, Containerized - k8S confguration and Testing
https://github.com/hmake98/nestjs-starter

boilerplate docker docker-compose jest-tests kubernetes nestjs postgres redis typescript

Last synced: 2 days ago
JSON representation

🚀 NestJS starter boilerplate with Basic Authentication, Swagger docs, Containerized - k8S confguration and Testing

Host: GitHub
URL: https://github.com/hmake98/nestjs-starter
Owner: hmake98
License: mit
Created: 2021-08-21T09:12:48.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2024-08-21T19:56:33.000Z (3 months ago)
Last Synced: 2024-08-21T22:15:11.883Z (3 months ago)
Topics: boilerplate, docker, docker-compose, jest-tests, kubernetes, nestjs, postgres, redis, typescript
Language: TypeScript
Homepage:
Size: 3.12 MB
Stars: 8
Watchers: 2
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# NestJS Starter Boilerplate
[![CodeQL](https://github.com/hmake98/nestjs-starter/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/hmake98/nestjs-starter/actions/workflows/github-code-scanning/codeql)
[![Run Tests](https://github.com/hmake98/nestjs-starter/actions/workflows/tests.yml/badge.svg)](https://github.com/hmake98/nestjs-starter/actions/workflows/main.yml)

Features:

✅ Basic Authentication

📚 Swagger API Documentation

🐳 Containerized with Docker

☸️ Kubernetes Configuration

🧪 Testing Setup

## Installation

```bash
$ yarn
```

## Running Server

```bash
# development
$ yarn dev

# production
$ yarn start
```

## Running all services on Docker

```bash
docker-compose up --build
```

## Run only database and redis services on Docker

```bash
docker-compose up postgres redis
```

## Build

```bash
yarn build
```

## Tests

```bash
# unit tests
$ yarn test
```

## Swagger Documentation

- Swagger documentation endpoint will be running at `/docs` .

## 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).

## Author

🇮🇳 Harsh Makwana

[Github](https://github.com/hmake98/nestjs-starter)
[Linkedin](https://www.linkedin.com/in/hmake98)
[Instagram](https://www.instagram.com/hmake98)