Bem-vindo (a) ao repositório do Projeto Diffusion (Backend).
Esta API permite criar e autenticar pessoas usuárias, criar, editar e deletar posts.
Typescript, Node, Sequelize, Docker.
Para acessar a documentação da API basta acessar o seguinte endereço, estando ela rodando:
http://localhost:3001/api-docs/
Para rodar este projeto é necessário ter instalado na máquina o Docker e Docker Compose ou o npm.
Possuindo as dependências necessárias na máquina, siga as intruções abaixo:
Rodando a aplicação com Docker Compose
- Para rodar a aplicação com o Docker Compose, digite o comando abaixo no terminal:
docker-compose up
-
Agora, copie as informações do arquivo .env.example para um arquivo .env
-
Feito isso, faça o reset do banco rodando o seguinte comando:
npm run db:reset
- Pronto! A API já está pronta para uso local.
Rodando a aplicação sem Docker
Para rodar a aplicação sem o Docker Compose:
Certifique-se de possuir um banco de dados MySql rodando em segundo plano com as configurações indicadas no arquivo .env.example (nome, host, usuário e senha).
- Instale as dependências do projeto:
npm install
- Inicie o servidor:
npm start
-
Agora, copie as informações do arquivo .env.example para um arquivo .env
-
Feito isso, faça o reset do banco rodando o seguinte comando:
npm run db:reset
- Pronto! A API já está pronta para uso local.