Blogger's Hub is a full-featured web application that allows users to create, read, update, and delete (CRUD) blog posts. Built with Node.js, Express, React, and PostgreSQL, this platform provides a seamless experience for bloggers to manage their content efficiently.
- Create Blogs: Users can create new blog posts with rich text formatting.
- Read Blogs: Browse and view blog posts with ease.
- Update Blogs: Edit existing blog posts to keep content up-to-date.
- Delete Blogs: Remove unwanted blog posts from the platform.
- Responsive Design: Accessible on various devices with a user-friendly interface.
- Frontend:
- React: JavaScript library for building user interfaces.
- Bootstrap: CSS framework for responsive design.
- Backend:
- Node.js: JavaScript runtime for server-side development.
- Express: Web framework for building RESTful APIs.
- Other:
- JWT (JSON Web Tokens): For secure user authentication.
- Sequelize: ORM for interacting with the PostgreSQL database.
- Axios: For making HTTP requests from the frontend to the backend.
Before you begin, ensure you have the following installed on your machine:
- Node.js (v14 or higher recommended)
- PostgreSQL (v13 or higher recommended)
- Git
Follow these steps to set up and run the Blogger's Hub project locally.
git clone https://github.com/your-username/bloggers-hub.git
cd bloggers-hubNavigate to both the frontend and backend directories and install the necessary packages.
- cd backend
- npm install
- cd ../frontend
- npm install
If using Sequelize migrations, run the following command to set up the database schema:
npm run migrate
Navigate to the backend directory and start the server:
cd backend npm start
The backend server will start on http://localhost:5000.
- Authentication
- Register User
- URL: /api/auth/register
- Method: POST
- Body:
- json { "username": "your_username", "email": "your_email@example.com", "password": "your_password" }
- Response: Returns a success message and JWT token upon successful registration.
Contributions are welcome! If you'd like to contribute to Blogger's Hub, please follow these steps:
-
Clone your fork:
-
cd bloggers-hub
-
Create a new branch:
-
git checkout -b feature/YourFeatureName
-
Make your changes: Implement your feature or bug fix.
-
Commit your changes:
-
git commit -m "Add your message here"
-
Push to your fork:
-
git push origin feature/YourFeatureName
-
Create a Pull Request: Go to the original repository and click the "Compare & pull request" button. Please ensure your code follows the project's coding standards and includes appropriate tests.
Save this content as README.md in the root directory of your project. This README provides a comprehensive overview of the Blogger's Hub application, including setup instructions, features, technologies used, and guidelines for contributing.