gustavo2892 / servico-aqui-server-node

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ServicoAqui API-Backend

API para agendamentos de prestadores de serviço.

Descrição

API em Node.js com Express desenvolvida utilizando as tecnologias e boas práticas mais utilizadas pelas empresas.

  • Express — Framework web para criar APIs em Node.js
  • 💎 Sequelize — ORM para Node.js que suporta banco de dados PostgreSQL e outros
  • 🐘 PostgreSQL — Banco de dados relacional
  • 🌱 MongoDB — Banco de dados não relacional orientado a documentos livres
  • 🔑 Redis — Armazenamento de dados na memória orientado a chave-valor
  • 🔍 Yup — Validação de formulários
  • 🔺 Sentry — Monitoramento de erros na aplicação
  • 📧 Nodemailer — Envia e-mails através do Node.js
  • 📝 ESLint/Prettier/Editor Config — Ferramentas para formatar e manter padrão de código

Dependências

Pré-Requisitos

Para rodar este servidor é necessário criar 3 containers no docker, para o PostgreSQL, MongoDB e Redis.

Com o Docker devidamente instalado, rode os seguintes comandos no seu terminal:

  • docker run --name redisservicoaqui -p 6379:6379 -d -t redis:alpine;
  • docker run --name mongoservicoaqui -p 27017:27017 -d -t mongo;
  • docker run --name pgservicoaqui -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres;

Obs: Caso você reinicie seu computador, deverá iniciar os containers novamente com docker start <nome_do_container>

Instalação

  1. Abra seu terminal em uma pasta qualquer e clone este repositório
    git clone repositório
  2. Navegue até o diretório do servidor: cd pasta-do-server
  3. Rode yarn para instalar todas as dependências
  4. Copie o arquivo .env.example e renomeie para .env
  5. Insira todos os valores para as variáveis de ambiente no .env
  6. Rode o comando yarn sequelize db:migrate
  7. Rode yarn start e yarn queue para iniciar a API no endereço http://localhost:3000.

About


Languages

Language:JavaScript 98.3%Language:Handlebars 1.2%Language:Shell 0.5%