danillogoncalves/27-project-blogs-api

Esse é um projeto que simula uma API e um banco de dados para a produção de conteúdo para um blog!

📮 BLOGS API

Sobre o projeto

Esse é um projeto que simula uma API e um banco de dados para a produção de conteúdo para um blog!

Ferramentas utilizadas

• Node.js
• Express
• Sequelize
• CRUD
• MSC
• REST

Orientações

Clonando o repositório e instalando os node modules

1. Clone o repositório

• git clone git@github.com:danillogoncalves/27-project-blogs-api.git;

• Entre na pasta que foi criada no processo de clonagem:

  • cd 27-project-blogs-api;

2. Faça a instalação das dependências

• npm install ou npm i;

🎲 Configurando o conexão com o banco de dados

1. Criando arquivo para a configuração

• Copie o arquivo .env.example na na raiz do projeto e renomeio para:

  • .env;

• Coloque as seguintes informações nesse arquivo:

  #### SERVER VARS
  NODE_ENV=development
  API_PORT=3000
  
  #### DATABASE VARS
  MYSQL_HOST=localhost
  MYSQL_PORT=3306
  MYSQL_DB_NAME=blogs-api
  MYSQL_USER=root
  MYSQL_PASSWORD=1234
  
  #### SECRECT VARS
  JWT_SECRET=suaSenhaSecreta
  

• Caso sua porta do API e do MySQL não seja a que estão descritas no arquivo .env, por favor altere para as que você usa, assim como o password do seu MySQL.

2. Variáveis Ambiente

• Caso queria conhecer mais sobre variáveis ambiente, segue link sobre:
  • https://blog.rocketseat.com.br/variaveis-ambiente-nodejs/

🏃 Rodando API localmente

• Rode o seguinte comando no terminal estando na raiz do projeto:

  • npm start;

• Caso você queira foi configurado no package.json um scripts para rodar a aplicação de formas alternativas;

🐳 Rodando via Docker

Caso você queria e tenha o conhecimento de como usar, existe um arquivo docker-compose na raiz do projeto, seque os comandos criar e acessar os containers:

• Na raiz do projeto rode o seguinte comando:

  • docker-compose up -d;

• Para acessar o terminal do container, roda o seguinte comando:

  • docker container exec -it blogs_api bash;

• Para fechar o terminal do container execute o comando:

  • exit;

• Se não for mais usar os containers, rode o seguinte comando:

  • docker-compose down;

👀 Teste a aplicação com API Client

🚧 Em construção 🚧

Todos os projetos da Trybe utilizam linters, Git e GitHub.