tsunode/gobarber_backend

Api para aplicação do GoBarber

GoBarber Backend

API desenvolvida para o GoBarber, uma aplicação para agendamento de cabeleireiros

Funcionalidades e Padrões de Arquitetura Utilizada:

• API:
  1. Arquitetura SOLID;
  2. ORM para comunicação com banco de dados;
  3. Alguns Conceitos de DDD;
  4. Teste unitários TDD;
  5. Banco SQL (Postgres) e NoSQL (mongoDB);
  6. Cache utilzando REDIS;
  7. UUID como identificador de cada tabela;
  8. AWS para disparo de e-mail (SES) e armazenamento (S3);

Requisitos de instalação

• npm >= 6.0.0
• node >= 10.0
• Postgres >= 10.0
• MongoDB
• Redis

Como utilizar

1. Na raiz do projeto crie um arquivo '.env' seguindo o parâmetro do arquivo .env.example., os parâmetros AWS_ACCESS_KEY_ID e AWS_SECRET_ACCESS_KEY são usados apenas em produção.

2. Existe um arquivo ormconfig.example.json na raiz do projeto. crie um arquivo no mesmo padrão dele porém sem o example (ormconfig.example.json -> ormconfig.json) e altere os seguintes dados de acordo com o seu banco POSTGRES e MONGODB: host, port, username, password, database. As demais informações desse arquivo já está configurado.

Sem a configuração desse arquivo corretamente, a api não funcionará.

Iniciando a API

Execute o comando para instalações de dependências da API:

yarn

ou

npm install

Execute o comando para rodar as Migrations, que criará as tabelas no banco:

É importante que os passos da sessão "Como Utilizar" esteje apontando para o banco corretamente.

npm run typeorm migration:run

ou

yarn typeorm migration:run

Se tudo ocorreu bem até aqui, basta iniciar a API com o seguinte comando:

npm run dev:server

ou

yarn dev:server