igorsfreitas/clean-node-api-boilerplate

Init de aplicação nodeJS usando Typescript, Node, Postgesql, typeorm, CI e Testes com 100% de cobertura usando os conceitos SOLID e CLEAN

Clean Blog API

Sobre

Projeto criado baseado no curso de Node.js do Rodrigo Manguinho, alterado algumas funcionalidades, mantendo apenas o cadastro de usuário e autenticação. Segui a mesma estrutura de Clean Architecture, TDD, SOLID, para aplicar as métodologias e práticas demonstradas no curso. Mudei a implementação para um banco relacional e um ORM (PostgreSQL/SQLite e TypeORM), junto com envio de e-mail (Nodemailer) e cache (Redis).

---

O que o projeto faz?

• Criação e autenticação de Usuaŕio
• Criação e listagem das postagens do usuário

---

Tecnologias

• Node.js

• Typescript

• Express

• TypeORM

• Jest

---

Download e instalação:

# Baixando o projeto
git clone https://github.com/igorsfreitas/clean-node-api-boilerplate.git

# Acessando a pasta
$ cd clean-blog-api

# Instalando as dependencias
# Com Yarn
$ yarn

Todos os arquivos de váriaveis de ambientes estão presentes no repositório, se necessário, crie o seu de acordo com o .env.example. Os arquivo de conexão com o banco está anexado ao repositório, com a conexão padrão e de teste.

Execução

# Ambiente de desenvolvimento
$ yarn dev

# Testes de integração e unitários
$ yarn test

# Build para produção(TS para JS)
$ yarn build

# Execução em produção
$ yarn start