Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ricardo-melo-martins/nestjs-skeleton
⚡ RMM ⚡ Standard and basic structure to assist in the quick start of tests, projects, pocs with this technology.
https://github.com/ricardo-melo-martins/nestjs-skeleton
nestjs node typeorm
Last synced: 1 day ago
JSON representation
⚡ RMM ⚡ Standard and basic structure to assist in the quick start of tests, projects, pocs with this technology.
- Host: GitHub
- URL: https://github.com/ricardo-melo-martins/nestjs-skeleton
- Owner: ricardo-melo-martins
- License: mit
- Created: 2024-02-22T00:03:39.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-30T00:54:19.000Z (9 months ago)
- Last Synced: 2024-11-15T08:09:44.713Z (2 months ago)
- Topics: nestjs, node, typeorm
- Language: TypeScript
- Homepage:
- Size: 271 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### ⚡ RMM ⚡
# NestJs Skeleton
Standard and basic structure to assist in the quick start of tests, projects, pocs with this technology.
`*pt-br` Estrutura padrão e básica para auxiliar no início rápido de testes, projetos, pocs com esta tecnologia.
## Description
Structure was based on
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
A progressive Node.js framework for building efficient and scalable server-side applications.
## Features
- Modular Structure
- Defines for Style and Linting (ESLint, Prettier, EditorConfig)
## Requirements
- Node > 18.x
- Database (Mysql, Postgres)
- Docker > 18.06 (Optional)
- For testing I using https://github.com/ricardo-melo-martins/docker
## Installation
Cloning
```bash
git clone https://github.com/ricardo-melo-martins/nestjs-skeleton.git
```
... entering on nestjs-skeleton dir
```bash
cd nestjs-skeleton
composer install
# make it yours (optional)
rm -rf .git
```
## Configure
Copy example environment
```bash
cp ./config/.env.example .env
```
then change the configuration according to the database you want to use.
### Database
```bash
DATABASE_DEFAULT_TYPE=mysql
DATABASE_DEFAULT_HOST=127.0.0.1
DATABASE_DEFAULT_PORT=3306
DATABASE_DEFAULT_DATABASE=my_database
DATABASE_DEFAULT_USERNAME=root
DATABASE_DEFAULT_PASSWORD=YourP@ssw0rd!
```
## Running the app
```bash
# development
npm run start
# watch mode
npm run start:dev
# production mode
npm run start:prod
```
## Test
```bash
# unit tests
npm run test
# e2e tests
npm run test:e2e
# test coverage
npm run test:cov
```
## License
Nest is [MIT licensed](LICENSE).