This repository contains the source code for the backend development of Blog-it, a simple web application for creating and managing blog posts.
- Create, edit, and delete blog posts.
- User accounts for secure access and post ownership.
- Categorize posts for better organization.
- Commenting system for user interaction.
Prerequisites:
- Node.js and npm (or yarn) installed on your system. You can download them from https://nodejs.org/en
Installation:
git clone https://github.com/mahmoudsalah296/Blog-it.git
cd Blog-it
npm install
1. Start the development server:
npm start
This will typically start the application on port 5000 (http://localhost:5000). You can check the console output for the exact port number.
2. (Optional) API Testing:
You can use a tool like Postman to test the application's APIs. The API documentation is still under development, but you can explore the functionalities in two ways:
- Send requests directly to the base URL:
http://localhost:5000/
. Refer to the source code for details on specific API endpoints and their functionalities. - Import the Postman collection for a more comprehensive testing experience: Postman API.
Note: While API documentation is still under development, you can leverage both methods to explore and test the application's functionalities.
3. API Documentation:
API documentation for this project was built using Swagger UI and can be found at the following link: Swagger API Docs.
- Node.js: JavaScript runtime environment for server-side development.
- Express.js: Web framework for building web applications and APIs in Node.js.
- JWT (JSON Web Token): A secure way to represent claims (like user information) between different parts of an application.
Contributions are welcome! If you'd like to contribute to Blog-it, please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature/new-feature
- Make your changes and commit them:
git commit -am 'Add new feature'
- Push to the branch:
git push origin feature/new-feature
- Submit a pull request.
- Ahmed Eid - GitHub
- Hamza - GitHub
- Mahmoud Salah - GitHub | LinkedIn
- Menna Hassan - GitHub | LinkedIn
The features mentioned above are subject to change based on development progress and user feedback. Feel free to open issues or suggest enhancements!