Teste feito por Vítor Mendes
Os passos abaixo irão ensinar como configurar o ambiente de desenvolvimento e como testar a API hospedada na AWS
- Faça a instalação do Node.js versão 14.15.4LTS ou superior, do SQL Server Management Studio versão 18.8 ou superior, do Git e do Postman
- Ao iniciar o SQL Server Management Studio utilize as crendencias e nome do servidor, que estão aqui, e em autenticação selecione 'Autenticação do SQL Server'.
- 🔴Importante🔴 as tabelas já estão criadas. para testar os scripts do banco de dados, que estão aqui, é necessário rodar os comandos nesta ordem:
DROP TABLE transacoes,contas
DROP TABLE pessoas,tipoTransacao
e então abrir uma nova consulta no banco dockDB e rodar os scripts do banco.
- Clone o repositório utiliznado o git e o comando.
git clone https://github.com/MendesVitor/Desafio-backend-Dock.git
- Para instalar as dependências do projeto execute o comando:
npm install
- Para iniciar o projeto em modo de desenvolvimento execute o comando:
npm run dev
- 🔴Importante🔴 Para testar com o Postman é so importar os arquivos com as rotas,que estão aqui, e importar o ambiente Dev, para testar a API hospedada na própria máquina, e importar o ambiente AWS para testar a API hospedada na AWS. Depois de importado é necessário selecionar o ambiente em que se deseja fazer a requisição.
- Express Framework para Node.js para ajudar no desenvolvimento da API.
- Body-parser É um módulo capaz de converter o body da requisição para vários formatos. Usaremos o formato JSON.
- Dotenv Carrega as variaves de ambiente de um arquivo .env para o process.env.
- node-mssql Utiliza o Tedious para fazer as querys no SQL Server.
- Eslint Usado para garantir o padrão do código.
- Prettier Usado para formatar o código.
- Eslint-config-prettier Usado para que não ocorra conflito entre as configurações do Eslint e do Prettier.
- Morgan Mostra no terminal logs das requisições HTTP.
- Nodemon Usado para automaticamente reiniciar o servidor quando alguma alteração é feita.
- Amazon Web Services para hospdar o banco de dados e a aplicação.
- Node.js versão 14.15.4LTS para desenvolver a API REST.
- Microsoft SQL Server 2017 Como banco de dados hospedado na AWS.
- SQL Server Management Studio versão 18.8 para as operações do banco de dados.
- Visual Studio Code versão 1.52 para criar o código e rodar a aplicação.
- Git para o controle de versão.
- Postman Usado para fazer as requisições HTTP e testar as rotas.