Api de Vendas - SOLID

Tecnologias | Projeto | Rodando | Como contribuir |

🚀 Tecnologias

💻 Projeto

Esse projeto apenas serve para eu aprofundar alguns conceitos de Solid com aplicações NodeJS, utilizando o micro-framework expressJS

Rodando o projeto 🌇

Requerimentos:

NodeJS
Docker
Aws -> serviço s3
Ethereal -> recomendado, mas pode usar o serviço de email ses também

📂 UM comando só:

☕ Pequena ajuda

Preencha o arquivo .env.example com as informações cobradas e depois renomeie para .env.

# PG Database
POSTGRES_USER=
POSTGRES_PASSWORD=

# PGAdmin
PGADMIN_DEFAULT_EMAIL=
PGADMIN_DEFAULT_PASSWORD=
PGADMIN_PORT=

# App

APP_SECRET=
APP_API_URL=http://localhost:3333
APP_WEB_URL=http://localhost:3000
REDIS_HOST=
REDIS_PORT=
REDIS_PASS=

# Mail Config: ethereal or ses
MAIL_DRIVER=ethereal

# Storage Config: disk or s3
STORAGE_DRIVER=disk

# AWS Credentials
AWS_REGION=
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=

🐬 Comando:

docker-compose up --build -V

Agora você pode acessar a API com a host http://localhost:3333

🤔 Como contribuir

Faça um fork desse repositório;
Cria uma branch com a sua feature: git checkout -b minha-feature;
Faça commit das suas alterações: git commit -m 'feat: Minha nova feature';
Faça push para a sua branch: git push origin minha-feature.

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.