Este projeto consiste em desenvolver uma API responsável pelo CRUD (criar, ler, atualizar e excluir registros de banco de dados) de um blog feito em volta do modelo MSC. A aplicação também realiza autenticação para conceder permissões aos usuários.
As principais tecnologias utilizadas no projeto são:
- MySQL
- Sequelize
- Node.js
- JavaScript
Todos os comandos descritos abaixo devem ser executados dentro da pasta raíz do projeto, após ser feito o clone do repositório com o comando git clone git@github.com:lauralana/Project-Blogs-API.git
🐋 Rodando no Docker vs Localmente
1.26.0
por 1.29.2
.
ℹ️ Rode os serviços
node
edb
com o comandodocker-compose up -d --build
.
-
Lembre-se de parar o
mysql
se estiver usando localmente na porta padrão (3306
), ou adapte, caso queria fazer uso da aplicação em containers; -
Esses serviços irão inicializar um container chamado
blogs_api
e outro chamadoblogs_api_db
; -
A partir daqui você pode rodar o container
blogs_api
via CLI ou abri-lo no VS Code;
ℹ️ Use o comando
docker exec -it blogs_api bash
.
- Ele te dará acesso ao terminal interativo do container criado pelo compose, que está rodando em segundo plano.
ℹ️ Instale as dependências [Caso existam] com
npm install
. (Instale dentro do container)
⚠️ Atenção: Caso opte por utilizar o Docker, TODOS os comandos disponíveis nopackage.json
(npm start, npm test, npm run dev, ...) devem ser executados DENTRO do container, ou seja, no terminal que aparece após a execução do comandodocker exec
citado acima.
ℹ️ Rode os scripts
npm run prestart
seguido denpm run seed
, estes scripts irão criar e popular o banco de dados da aplicação.
ℹ️ Rode o script
npm start
. Este irá iniciar a API na porta estipulada pelo arquivodocker-compose.yml
ℹ️ Instale as dependências [Caso existam] com
npm install
ℹ️ Configure o arquivo .env na pasta raiz do projeto com as variáveis de ambiente respectivas. (Há um arquivo
.env.example
que possui exemplos de como configurar o arquivo.)
ℹ️ Rode os scripts
npm run prestart
seguido denpm run seed
, estes scripts irão criar e popular o banco de dados da aplicação.
ℹ️ Rode o script
npm start
. Este irá iniciar a API na porta estipulada pelo arquivo.env
.