Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raphaelalmeidamartins/blogs-api
RESTful API developed with Node.js, Express.js and Sequelize.js at the end of Unit 24 (Back-end Development Module) of the Trybe's Web Development course
https://github.com/raphaelalmeidamartins/blogs-api
docker docker-compose expressjs joi-validation mysql nodejs sequelize swagger
Last synced: 1 day ago
JSON representation
RESTful API developed with Node.js, Express.js and Sequelize.js at the end of Unit 24 (Back-end Development Module) of the Trybe's Web Development course
- Host: GitHub
- URL: https://github.com/raphaelalmeidamartins/blogs-api
- Owner: raphaelalmeidamartins
- Created: 2022-07-18T03:34:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-25T03:03:05.000Z (over 2 years ago)
- Last Synced: 2023-03-03T23:28:41.939Z (over 1 year ago)
- Topics: docker, docker-compose, expressjs, joi-validation, mysql, nodejs, sequelize, swagger
- Language: JavaScript
- Homepage: https://blogs-api-24072022.herokuapp.com/docs/en/
- Size: 811 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# :computer: Blogs API :writing_hand:
## :page_with_curl: About/Sobre
:us: English
Node.js and Express.js project developed by [Raphael Martins](https://www.linkedin.com/in/raphaelameidamartins/) at the end of Unit 24 ([Back-end Development Module](https://github.com/raphaelalmeidamartins/trybe_exercicios/tree/main/3_Desenvolvimento-Back-end)) of Trybe's Web Development course. I was approved with 100% of the mandatory and optional requirements met.
We had to create a blog RESTful API using MSC (Model-Service-Controller) architecture. We must use the Sequelize.js ORM to connect with the database, and handle authentication with Json Web Token.
[Click here](https://blogs-api-24072022.herokuapp.com/docs/en/) to check out the final version of the project on your browser.
:brazil: Português
Projeto Node.js, Express.js e Sequelize.js desenvolvido por [Raphael Martins](https://www.linkedin.com/in/raphaelameidamartins/) ao final do Bloco 24 ([Módulo Desenvolvimento Back-end](https://github.com/raphaelalmeidamartins/trybe_exercicios/tree/main/3_Desenvolvimento-Back-end)) do curso de Desenvolvimento Web da Trybe. Fui aprovado com 100% dos requisitos obrigatórios e opcionais atingidos.
Tivemos que criar uma API RESTful de blog usando a arquitetura MSC (Model-Service-Controller). A conexão com o banco de dados precisou ser feita com o ORM Sequelize e a autenticação com Json Web Token.
[Clique aqui](https://blogs-api-24072022.herokuapp.com/docs/br/) para conferir a versão final do projeto no seu navegador.
## :man_technologist: Developed Skills/Habilidades Desenvolvidas
:us: English
* Create an Express.js application
* Create a RESTful API using MSC (Model-Service-Controller) architecture
* Validate requests' data with the Joi library
* Implement authentication with Json Web Token (JWT)
* Use the Sequelize.js ORM to connect with the database and perform queries
:brazil: Português
* Criar uma aplicação Express.js
* Criar uma API RESTful usando arquitetura MSC (Model-Service-Controller)
* Validar dados das requisições com a biblioteca Joi
* Implementar autenticação por Json Web Token (JWT)
* Usar o ORM Sequelize.js para fazer a conexão e queries no banco de dados
## :hammer_and_wrench: Tools/Ferramentas
* Node.js
* Express.js
* Sequelize.js
* Express Rescue
* Json Web Tokens
* DotEnv
* Joi
* Docker
* MySQL
## :whale2: Installation and execution with Docker/Instalação e execução com Docker
:us: English
To run this application you need to have **Git**, **Docker** and **Docker Compose** installed on your machine. Docker Compose needs to be at **1.29** version or superior.
### 1 - Clone the repository
```sh
git clone https://github.com/raphaelalmeidamartins/blogs-api
```
### 2 - Run the containers by running the command below in the application folder
```sh
docker-compose up -d --build
```
### 3 - Run this command to attach the container to your terminal
```sh
docker exec -it blogs_api bash
```
### 4 - On the attached container, install the dependencies and run the application
Install the dependencies:
```sh
npm install
```
Run the application:
```sh
npm start
```
### 5 - Access the documentation and make requests to the server running on the port 3000
Access the route http://localhost:3000/docs/en to see the English documentation and try the API. If you prefer, you can use a HTTP requests client of your choice (Insomnia, Thunder Client, etc) to make requests.
:brazil: Português
Para rodar está aplicação é necessário ter **Git**, **Docker** e o **Docker Compose** instalados no seu computador. O Docker Compose precisa estar na versão **1.29** ou superior.
### 1 - Clone o repositório
```sh
git clone [email protected]:raphaelalmeidamartins/blogs-api.git
```
### 2 - Rode os containers executando o comando abaixo na pasta raiz da aplicação
```sh
docker-compose up -d --build
```
### 3 - Rode o comando para abrir o terminal do container blogs_api
```sh
docker exec -it blogs_api bash
```
### 4 - No terminal do container, installe as dependências e execute a aplicação
Instalando dependências:
```sh
npm install
```
Executando aplicação:
```sh
npm start
```
### 5 - Acesse a documentação e faça requisições para o servidor aberto na porta 3000
Acesse a rota http://localhost:3000/docs/br para acessar a documentação em português e testar a API. Se preferir, utilize um cliente de requisições HTTP de sua preferência (Insomnia, Thunder Client, etc) para fazer as requisições.
## :books: Documentation/Documentação
:us: English
With the application running, enter the http://localhost:3000/docs/en route on your browser to see the English documentation. If you prefer, [checkout the deploy on Heroku](https://blogs-api-24072022.herokuapp.com/docs/en/)
:brazil: Português
Com a aplicação em execução, acesse a rota http://localhost:3000/docs/br no navegador para ver a documentação em português. Se preferir, [acesse o deploy no Heroku](https://blogs-api-24072022.herokuapp.com/docs/br/).
## :trophy: Grade/Nota
