|
|
|
### Configuração
|
|
|
|
|
|
|
|
A configuração de cada ambiente está no `config/environments/<env>.js`. Para desenvolvimento vamos utilizar o arquivo `config/environments/development.js`. Nele esta configurado para subir a aplicação na porta `3000` e utilizar o MongoDB com a seguinte config:
|
|
|
|
|
|
|
|
```
|
|
|
|
username: "admin",
|
|
|
|
password: "p1c4d1nh0",
|
|
|
|
database: "dev"
|
|
|
|
```
|
|
|
|
|
|
|
|
### Requisitos
|
|
|
|
|
|
|
|
Será necessário ter em sua máquina:
|
|
|
|
- [Node](https://nodejs.org/en/).
|
|
|
|
- [Docker ](https://www.docker.com/) ou [MongoDB ](https://www.mongodb.com/) local.
|
|
|
|
|
|
|
|
### Configurando MongoDB
|
|
|
|
|
|
|
|
#### Docker
|
|
|
|
- Na raiz do repositório existe um arquivo chamado `docker-compose.yml`. Com ele é possível subir uma instancia do MongoDB, já configurada para ser utilizada localmente. Para isso é preciso ter instalado o Docker em sua máquina (Linux ou Windows). Com o Docker rodando, o seguinte comando pode ser executado ` docker-compose up -d `
|
|
|
|
|
|
|
|
Após isto o MongoDB já estará rodando.
|
|
|
|
|
|
|
|
#### Sem Docker
|
|
|
|
|
|
|
|
- Também é possível utilizar o MongoDB localmente. Para isto basta configurar o usuário e senha de acordo com o env do projeto.
|
|
|
|
|
|
|
|
### Dependências
|
|
|
|
|
|
|
|
Para que todas as dependências do projeto sejam instaladas pode ser utilizado o gerenciador de pacotes [NPM](https://nodejs.org/en/knowledge/getting-started/npm/what-is-npm/).
|
|
|
|
|
|
|
|
Com o repositório clonado, navegue até o a pasta raiz do projeto, e execute, ` npm install `.
|
|
|
|
|
|
|
|
### Rodando
|
|
|
|
|
|
|
|
Depois das devidas configurações, basta executar o seguinte comando para rodar o projeto, `npm run dev`.
|
|
|
|
|
|
|
|
### Swagger e docs
|
|
|
|
|
|
|
|
O projeto conta com um middleware do Swagger para automaticamente documentar as rotas desenvolvidas. Para visualiza-lo, com o projeto em execução, basta acessar `http://localhost:3000/api/docs`.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|