🌐 Connectly API

A robust, scalable backend for a modern social platform — enabling users to post, comment, and engage with content while ensuring secure authentication, privacy controls, and role-based access. Built with integration and analytics in mind.

---

✨ Features

• 🧑‍🤝‍🧑 User Authentication with email verification
• 🔐 Privacy & Role-based Access Control
• 📝 Post & Comment System with likes
• 📊 Full REST API
• 🔧 Easy local development setup
• 💬 RESTful API Design

---

📚 API Testing

All API endpoints are available as .http files in the http/ directory for easy testing with VS Code REST Client extension.

👉 Install REST Client extension and click "Send Request" on any file.

---

🛠️ Tech Stack

• Backend: Spring Boot 3
• Database: PostgreSQL
• Authentication: JWT
• Email: MailHog (local development)
• Build: Gradle

---

🚀 Getting Started

Prerequisites

• Java 17+
• PostgreSQL (running locally)
• Gradle (included with ./gradlew)
• Docker (optional, for MailHog)

Quick Setup

1. Clone & Navigate

git clone https://github.com/jomariabejo/connectly-api.git
cd connectly-api

2. Setup PostgreSQL Database

# Create database
createdb connectly_db

# If using different credentials, update src/main/resources/application.properties

3. Setup Local Email with MailHog

For development, we use MailHog to capture emails locally:

Option A: Using Docker (easiest)

docker run -d --name mailhog -p 1025:1025 -p 8025:8025 mailpit/mailpit

Option B: Direct Install (requires Go)

go install github.com/mailhog/MailHog@latest
MailHog

Once running:

• 📧 SMTP Server: localhost:1025 (app sends emails here)
• 🌐 Web UI: http://localhost:8025 (view sent emails)

4. Run the Application

./gradlew bootRun

The API will be running at http://localhost:8080

---

📡 API Endpoints

Authentication

• POST /auth/registration - Register new user
• POST /auth/login - Login user
• GET /auth/verify?token=TOKEN - Verify email

Users

• GET /api/users/me - Get current user profile
• PUT /api/users/me - Update profile

Posts

• POST /api/posts - Create post
• GET /api/posts - Get all posts
• GET /api/posts/{id} - Get single post
• PUT /api/posts/{id} - Update post
• DELETE /api/posts/{id} - Delete post
• POST /api/posts/{id}/like - Like post
• DELETE /api/posts/{id}/like - Unlike post

Comments

• POST /api/comments - Create comment
• GET /api/comments/post/{postId} - Get post comments
• PUT /api/comments/{id} - Update comment
• DELETE /api/comments/{id} - Delete comment

---

🧪 Testing API Requests

1. Install REST Client extension in VS Code
2. Open any file in http/ folder
3. Click "Send Request" button above the request
4. View response in the sidebar

Example: http/auth/register.http

---

🤝 Contributing

Feel free to submit issues and enhancement requests!