Skip to content
queitePublic

About

REST API to manage a blog with the MSC software architecture using Node, Express and Sequelize.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

BLOGS API ⌨️

Project developed in the Back-end Module at the Trybe course.

🎯

The project goal was to develop a database using Sequelize and a REST API to manage a blog with the MSC software architecture using Node and Express.
The API presents all the CRUD operations.
JWT is present in the authentications, meanwhile, Joi handles the validations.

✨Features

Feature Route
Login POST /login
Create User POST /user
List all users GET /user
Get user by ID GET /user/:id
Create post category POST /categories
List post categories GET /categories
Create a blog post linking it to categories POST /post
List all blog posts with their users and categories GET /post
Get by ID the blog post with its user and categories GET /post/:id
Update the title and/or content of a blog post if the logged user is the author PUT /post/:id
Delete post by ID if the logged user is the author DELETE /post/:id
Delete the logged user DELETE /user/me
Search for title or content using a query string GET /post/search

📜Documentation

Access the route /api-docs to see the documentation.

Ex.: http://localhost:3000/api-docs



🛠️ Tools:


How to install the application:

Download the code:

git clone git@github.com:queite/blogs-api.git

Enter the root folder:

cd blogs-api

Install dependencies:

npm install

Run database service on docker:

docker compose up -d db --build

Start the API:

npm start

All Trybe projects use linters, Git and GitHub.

About

REST API to manage a blog with the MSC software architecture using Node, Express and Sequelize.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages