Skip to content

Files

Latest commit

amaanlariamaanlari
amaanlari
and
amaanlari
Blogging feature/blog post features (#10)
Mar 12, 2025
effb15c · Mar 12, 2025

History

History
137 lines (104 loc) · 3.73 KB

README.md

File metadata and controls

137 lines (104 loc) · 3.73 KB

Blogger Hub - Backend

Blogger Hub is a comprehensive blogging platform that enables users to create, manage, and share blogs seamlessly. This repository contains the backend API implementation built using Spring Boot and MongoDB with enterprise-level practices.

Features

  • User Module

    • User registration and login (JWT-based authentication)
    • User profile management
    • Follow and unfollow users

  • Blog Module

    • Create, update, delete, and view blogs
    • Like and comment on blogs
    • Support for threaded replies in comments

  • Media Management

    • Store profile pictures and blog images using Cloudinary

  • Database

    • MongoDB for managing users, blogs, and interactions

Features in Progress

  • User Follow Feature

    • Follow and unfollow users

  • Notification Module

    • Real-time notifications using queuing system (RabbitMQ or Apache Kafka etc.)
    • Notifications for likes, comments, and follows

Tech Stack

  • Backend Framework: Spring Boot
  • Database: MongoDB (with migration plans to DynamoDB)
  • File Storage: Cloudinary
  • API Documentation: Postman
  • Build Tool: Maven

Project Structure

blogger-hub/
├── src/
│   ├── main/
│   │   ├── java/com/bloggerhub/
│   │   │   ├── config/           # Configuration files
│   │   │   ├── constant/         # Constants files
│   │   │   ├── controllers/      # REST controllers
│   │   │   ├── document/         # Entity classes
│   │   │   ├── dto/              # DTO classes
│   │   │   ├── enums/            # Enum classes
│   │   │   ├── repository/       # Database repositories
│   │   │   ├── response/         # API responses
│   │   │   ├── security/         # Security filters and configs 
│   │   │   ├── service/          # Business logic
│   │   │   └── util/             # Utility classes
│   └── test/
│       └── java/com/bloggerhub/  # Unit and integration tests
├── pom.xml                       # Maven configuration
└── README.md                     # Project documentation

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/blogger-hub.git
cd blogger-hub

  2. Update the application.yml file with your MongoDB and Cloudinary credentials.

  3. Build the project:

    mvn clean install

  4. Run the application:

    mvn spring-boot:run

API Documentation

The API documentation is available via Swagger at:

http://localhost:8080/swagger-ui/index.html

Development Setup

Prerequisites

  • Java 17 or higher
  • MongoDB installed locally or accessible via cloud
  • Kafka broker setup (local or cloud)

Configuration

The application uses profiles for different environments. Set the active profile as needed using the follwing:

  -Dspring.profiles.active=<profile>

                    OR

  -Dspring-boot.run.profiles=<profile>

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature/fix: 
    git checkout -b feature-name
  3. Commit your changes: 
    git commit -m "Add new feature"
  4. Push to your branch: 
    git push origin feature-name
  5. Create a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For queries, reach out to Amaan Lari: