gabrielhdn / blogs-api

Blogs API

O Blogs API é um servidor back-end integrado ao banco de dados MySQL. A aplicação foi construída com o objetivo de produzir e gerenciar conteúdos para um blog. O projeto conta com CRUD feito em arquitetura MSC (Model, Service e Controller) e autenticação de token via JWT.

Tecnologias

• JavaScript
• Node.js
• Express.js
• MySQL
• Sequelize
• JSON Web Token (JWT)
• Joi
• Docker

Executando o projeto

É recomendável utilizar o Docker para a execução do Blogs API. O arquivo docker-compose.yml, localizado na raiz do projeto, cria dois contêineres: "blogs_api" (back-end em Node.js) e "blogs_api_db" (database em MySQL).

⚠️ Seu docker-compose precisa estar na versão 1.29 ou superior. Veja aqui ou na documentação como instalá-lo. No primeiro artigo, você pode substituir onde está 1.26.0 por 1.29.2.

⚠️ Lembre-se de parar o MySQL se estiver usando localmente na porta padrão (3306), ou adapte.

Na raiz, execute o seguinte comando para iniciar os contêineres em segundo plano:

docker-compose up -d --build

Você agora pode acessar o contêiner "store_manager" pelo VSCode ou conectar-se a ele pelo terminal em modo interativo:

docker exec -it blogs_api bash

Dentro do contêiner, execute as dependências e inicie o servidor:

npm install
npm run debug

⚠️ TODOS os comandos disponíveis no package.json (npm start, npm test, npm run debug, ...) devem ser executados DENTRO do contêiner, ou seja, no terminal que aparece após a execução do comando docker exec citado acima.

✨ Dica: A extensão Remote - Containers (que estará na seção de extensões recomendadas do VS Code) é indicada para que você possa desenvolver sua aplicação no contêiner Docker direto no VSCode, como você faz com seus arquivos locais.