Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qytela/nest-starter
I am lazy to create a project with NestJS and do the same thing over and over again, so I created this Starter Project to avoid repetition.
https://github.com/qytela/nest-starter
boilerplate javascript nest nest-best-practice nest-starter-project nestjs nodejs sequelize-orm starter typescript
Last synced: about 2 months ago
JSON representation
I am lazy to create a project with NestJS and do the same thing over and over again, so I created this Starter Project to avoid repetition.
- Host: GitHub
- URL: https://github.com/qytela/nest-starter
- Owner: qytela
- Created: 2023-09-19T06:54:48.000Z (over 1 year ago)
- Default Branch: 1.x
- Last Pushed: 2024-03-20T08:04:08.000Z (10 months ago)
- Last Synced: 2024-03-20T09:28:23.922Z (10 months ago)
- Topics: boilerplate, javascript, nest, nest-best-practice, nest-starter-project, nestjs, nodejs, sequelize-orm, starter, typescript
- Language: TypeScript
- Homepage:
- Size: 262 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Supercharge Your Node.js Applications with Nest
A progressive Node.js framework for building efficient and scalable server-side applications.
## Welcome to the Nest Starter Kit 🔥
[](https://github.com/qytela/nest-example/commits/1.x)
This is the Nest 10 Starter or Boilerplate to avoid the same things over and over again. 🚀
## Table of Contents 📕
- [Requirements and Features](#requirements-and-features)
- [Documentation](#documentation)
- [Getting Started](#getting-started-is-a-breeze)
- [Installation](#installation)
- [Setting up .env](#setting-up-env)
- [Generate App Key](#generate-app-key)
- [Migrations and Seeders](#migrations-and-seeders)
- [Running the app](#running-the-app)
- [Default Routes](#default-routes)
- [Commander](#commander)
- [Cooming Soon](#cooming-soon)
## **Requirements and Features**
Requirements:
- **Node.js v16.x or higher:** As of NestJS 10, we no longer support Node.js v12, as v12 went EOL on April 30, 2022. This means that NestJS 10 requires Node.js v16 or higher ([migration guide](https://docs.nestjs.com/migration-guide#dropping-support-for-nodejs-v12)).
Features:
- **Passport Authentication:** 🔐 Secure your app with Passport authentication.
- **Sequelize ORM:** 🎲 Interact with databases seamlessly using Sequelize ORM.
- **[Sentry & Telegram Integration](https://github.com/qytela/nest-starter/blob/1.x/SENTRY.md):** 🚨 Keep an eye on your app's health with Sentry and stay notified via Telegram.
- **Custom Decorators:** 🖋 Simplify your code with the Custom Decorators.
- **Fastify Adapter:** ⚡ Optimize performance with Fastify Adapter (switch to Express anytime).
- **Commander:** ⚙️ Harness the power of Commander for efficient command-line operations.
## **Documentation**
See more documentation [here](https://github.com/qytela/nest-starter/blob/1.x/DOCS.md). 📁
## **Getting Started is a Breeze!**
### **Installation:**
```bash
$ git clone https://github.com/qytela/nest-starter.git
$ cd nest-starter
$ yarn install
```
### **Setting up .env**
```bash
$ cp .env.example .env
```
> Nest Starter has [Default Routes](#default-routes) make you must to configure database first.
### **Generate App Key**
```bash
$ node cmd generate:key --length
```
> This is required as an authentication secret, default length: 16
### **Migrations and Seeders**
```bash
$ npx sequelize-cli db:migrate
$ npx sequelize-cli db:seed:all
```
> This command requires sequelize-cli with npx, see more [here](https://sequelize.org/docs/v6/other-topics/migrations).
### **Running the app**
```bash
# development
$ yarn run start
# watch mode
$ yarn run start:dev
# production mode
$ yarn run start:prod
```
### **Default Routes**
- / (Default)
- /auth/login (Authentication)
```json
{
"username": "admin",
"password": "password"
}
```
- /auth/register (Registration)
```json
{
"fullname": "Qytela",
"username": "qytela",
"password": "password",
"email": "[email protected]"
}
```
## **Commander**
Make life easier with commander. ⚙️
```bash
$ node cmd help
Usage: cmd [options] [command]
Options:
-h, --help display help for command
Commands:
generate:key|gk [options] Generate app key
generate:model|gmo [options] Generate new model
generate:migration|gmi [options] Generate new migration
generate:validation|gvl [options] Generate new custom validator
generate:resource|gr [options] Generate new resource and collection
help [command] display help for command
```
## **Cooming Soon**
Here's a sneak peek at what's coming in the next releases 🔜:
- [x] **Permissions**
- [x] **Storage: AWS S3, Local**
- [x] **Mailer**
- [ ] **Social Login**
- [ ] **Dockerize App**
- [ ] **And Many More...**
Feel free to open an issue, share your thoughts, or suggest new features. Your input helps this project become better. 🌟
## **License**
Nest is [MIT licensed](LICENSE).