GoFr-SOC: Template Track – Blog Service

[SAMMILLERR]

GoFr-SOC: Template Track – Blog Service

Hi GoFr Team! 👋

I'm excited to be part of the GoFr Summer of Code and to work on the Blog Service template project.

---

📦 Project Overview

I plan to build a lightweight Content Management System (CMS) using the GoFr framework with the following core features:

• Markdown content APIs for blog posts
• Media/image upload support
• Post, tag, author, and comment management
• SEO metadata support and full-text search

---

🗓️ Development Timeline & Deliverables

PR #1: Project Foundation & Basic Post CRUD

📅 Week 1 – Days 1–4

Deliverables:

• Project structure setup with GoFr framework
• Post model with database migration
• Basic CRUD operations for posts
• RESTful API endpoints for post management
• Unit tests
• Input validation and error handling

Endpoints:

• GET /api/v1/posts
• GET /api/v1/posts/{id}
• POST /api/v1/posts
• PUT /api/v1/posts/{id}
• DELETE /api/v1/posts/{id}

---

PR #2: Author Management & Authentication

📅 Week 1–2 – Days 5–8

Deliverables:

• Author model and database schema
• JWT-based authentication
• Author CRUD operations
• Auth middleware for protected routes
• Author-post relationships
• Unit tests

---

PR #3: Tags & Categorization System

📅 Week 2 – Days 9–11

Deliverables:

• Tag model with many-to-many relation
• Tag CRUD operations
• Post-tag association/dissociation
• Tag-based filtering
• Unit tests

---

PR #4: Media Upload & File Management

📅 Week 2–3 – Days 12–16

Deliverables:

• Secure file/image upload system
• Image validation and processing
• Media model and DB migration
• Media-post integration
• File storage and security
• Unit tests

---

PR #5: Comments System

📅 Week 3 – Days 17–20

Deliverables:

• Comment model and CRUD operations
• Comment-post relationship
• Moderation and nested comments
• Unit tests

---

PR #6: SEO & Search Features

📅 Week 3–4 – Days 21–25

Deliverables:

• SEO metadata for posts
• Full-text search support
• Related/popular posts suggestions
• Search optimization
• Unit tests

---

PR #7: API Documentation & Production Ready

📅 Week 4 – Days 26–28

Deliverables:

• OpenAPI/Swagger documentation
• Docker setup (Dockerfile + docker-compose)
• Health checks, logging, rate limiting
• Integration & performance tests
• CI/CD pipeline

---

🛠️ Technical Stack

• Framework: GoFr (context-based handler architecture)
• Database: PostgreSQL
• Authentication: JWT with bcrypt
• API Style: RESTful with proper HTTP status codes
• Testing: Unit + Integration tests with >80% coverage
• Docs: OpenAPI specification

---

✅ Success Criteria for Each PR

• Working, testable feature

• 80% test coverage

• Proper error handling
• Clear documentation
• Follows GoFr conventions
• Passes linting
• No breaking changes

---

🚀 Repository & Workflow

• Repo: https://github.com/SAMMILLERR/gofr-SCO-blog-service.git
• Main Branch: main
• Development Branches: feature/<pr-name>

---

📚 Learning Goals

• Master GoFr project architecture
• Build secure and scalable REST APIs
• Handle media uploads and file storage
• Implement efficient full-text search
• Prepare production-ready systems with CI/CD

---

✅ Next Steps

1. Set up the initial project structure
2. Complete PR Adding Gopher Mascot #1 implementation
3. Submit the first pull request for review

Looking forward to building an awesome blog service with GoFr! 🚀
Thanks for this opportunity! 🙌

[SAMMILLERR]

@coolwednesday i am done with my PR_1 work what should i do next??

[coolwednesday]

Please add @Umang01-hash as an collaborator for PR reviews.