https://github.com/gabrielamoura25/blogs-api
A API de Blogs é uma APIRest e banco de dados para gerenciamento da produção de conteúdo de um blog.
https://github.com/gabrielamoura25/blogs-api
express javascript joi jwt mysql nodejs sequelize sql
Last synced: 7 days ago
JSON representation
A API de Blogs é uma APIRest e banco de dados para gerenciamento da produção de conteúdo de um blog.
- Host: GitHub
- URL: https://github.com/gabrielamoura25/blogs-api
- Owner: GabrielaMoura25
- Created: 2022-12-04T22:58:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-01T14:35:41.000Z (about 3 years ago)
- Last Synced: 2025-04-01T23:31:11.782Z (about 1 year ago)
- Topics: express, javascript, joi, jwt, mysql, nodejs, sequelize, sql
- Language: JavaScript
- Homepage:
- Size: 291 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API de blogs
A [ Trybe ](https://www.betrybe.com/) é uma escola de tecnologia focada na formação de Desenvolvedores Web e o projeto API de Blogs foi proposto como uma atividade para aprimorar os estudos sobre desenvolvimento back-end.
## Descrição
O aplicativo é uma API e um banco de dados com o conteúdo de um blog. Deve permitir criar, ler, atualizar e remover informações do blog do banco de dados. Ele também realiza autenticação para conceder permissões aos usuários.
## Tecnologias e Ferramentas
Na elaboração da API RESTful foi utilizada a arquitetura **Model-Service-Controller(MSC)** . As demais tecnologias e ferramentas foram:
- [ Node.JS ](https://nodejs.org/en/)
- [ Expresso ](https://expressjs.com/pt-br/)
- [ Mysql ](https://www.mysql.com/)
- [ Docker ](https://www.docker.com/)
- [ Sequelize ](https://sequelize.org/)
## ⚙️ Como usar
Para executar o aplicativo, inicie com o clone do repositório usando o comando abaixo.
git clone git@github.com:GabrielaMoura25/blogs-api.git
Navegue até a raiz do projeto
cd blogs-api/
Executando localmente
Obs: Para rodar a aplicação desta forma você deve ter o [ Node ](https://nodejs.org/en/) instalado em sua máquina.
Na raiz do projeto execute o comando abaixo para instalar as dependências.
npm instalar
Faça login no banco de dados usando suas credenciais.
mysql -u -p
Execute os comandos para criar o banco de dados **BlogsApi**
npm pré-início
Inicie o aplicativo com nodemon usando o comando abaixo.
npm depurar
Executando com o Docker
Obs: Para executar o aplicativo desta forma você deve ter o [ Docker ](https://www.docker.com/) instalado em sua máquina.
Na raiz do projeto, carregue os contêineres blogs_api e blogs_api_db usando docker-compose.
docker-compose up -d
Abra o terminal de contêiner blogs_api.
docker exec -it blogs_api bash
Uma vez no terminal do contêiner, execute o comando abaixo para instalar as dependências.
npm instalar
Para se conectar ao banco de dados, abra o terminal de contêiner blogs_api_db.
docker exec -it blogs_api_db bash
Faça login no banco de dados usando as credenciais descritas em docker-compose.yaml.
mysql -r raiz -p
Para criar o banco de dados, execute o comando abaixo no terminal do container store_manager.
npm pré-início
Para iniciar o servidor com nodemon use o comando abaixo no terminal do container store_manager.
npm executar depuração
## Rotas
Você pode verificar todas as rotas acessando o endpoint /docs em seu navegador ao executar o aplicativo.
Visualização de rotas
---
Desenvolvido por [Gabriela Moura](https://www.linkedin.com/in/gabriela-daniel-moura/), © 2022.