https://github.com/pedroemmanuelbuerger/blogs-api
The Blogs API is a project developed to create an API that allows the creation, editing, and viewing of blogs and their respective posts. This API was developed using best practices in BackEnd development with MySQL and offers a simple and intuitive application for interacting with blogs and their contents.
https://github.com/pedroemmanuelbuerger/blogs-api
backend beekeeper javascript msc mysql nodejs postman
Last synced: 2 months ago
JSON representation
The Blogs API is a project developed to create an API that allows the creation, editing, and viewing of blogs and their respective posts. This API was developed using best practices in BackEnd development with MySQL and offers a simple and intuitive application for interacting with blogs and their contents.
- Host: GitHub
- URL: https://github.com/pedroemmanuelbuerger/blogs-api
- Owner: PedroEmmanuelBuerger
- Created: 2023-06-06T06:42:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-27T17:44:05.000Z (3 months ago)
- Last Synced: 2025-03-06T19:44:47.045Z (2 months ago)
- Topics: backend, beekeeper, javascript, msc, mysql, nodejs, postman
- Language: JavaScript
- Homepage:
- Size: 222 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Blogs API
The Blogs API is a project developed to create an API that allows the creation, editing, and viewing of blogs and their respective posts. This API was developed using best practices in BackEnd development with MySQL and offers a simple and intuitive application for interacting with blogs and their contents.
## Features
The project includes the following features:
- **Blog Creation:** Allows the creation of new blogs with information such as title, description, and author.
- **Post Creation:** Enables the creation of new posts for a specific blog, with title, content, and publication date.
- **Editing Blogs and Posts:** Allows the editing of information for an existing blog or post.
- **Viewing Blogs and Posts:** Displays registered blogs and posts, enabling filtering by author, date, and other criteria.
## Technologies Used
The project was developed using the following technologies:
- **Node.js**
- **MySQL**
- **Postman**
- **JavaScript**
- **Sequelize**
- **Beekeeper**
## Installation
To install and run the project locally, follow these steps:
- Clone the repository to your local machine: `git clone https://github.com/PedroEmmanuelBuerger/project-blogs-api.git`
- Install Node.js on your machine.
- In the project folder, install the dependencies by running the command: `npm install`
- Start the server by running the command: `npm start`
- The API will be available at `http://localhost:3001`.
## Key Learnings
During the development of this project, the concepts of API development with Node.js and JavaScript were explored, as well as integration with the MySQL database using the mySQL2 library. JavaScript knowledge was also applied for data manipulation and the construction of the API logic, using the MSC (Model Service Controller) pattern.
## Conclusion
The Blogs API provides a robust and flexible solution for the creation and management of blogs and their posts. With a well-defined structure and an easy-to-use interface, this API is ideal for developers who want to implement blog functionality in their projects.