feat(docs): feature docs

Author: sheenazien8

.opencode/init

@@ -0,0 +1,29 @@
+# GoPlate Agent Context
+
+This guide provides essential dev context for automated agents working in this repository (GoPlate — a Go-based REST API boilerplate).
+
+## 1. Build, Lint, and Test
+- **Build**: `make build` or `go build -o server main.go`
+- **Run**: `make run` (builds then runs)
+- **Dev (hot reload)**: `make dev` (needs reflex)
+- **Format**: `make fmt` or `go fmt ./...`
+- **Test all**: `make test` or `go test ./...`
+- **Test (single file)**: `go test ./path/to/pkg/file_test.go`
+- **Test Coverage**: `make test-coverage`
+- **Linting**: Uses `go fmt` (strict gofmt style); no golangci-lint config by default
+
+## 2. Code Style Guidelines
+- **Imports**: Standard library, then third-party, then local imports (grouped, no blank lines between groups)
+- **Formatting**: Always use `gofmt`; tabs not spaces
+- **Types**: Prefer explicit struct field types; use `interface{}` or `any` sparingly (replace where modern Go suggests)
+- **Naming**: `CamelCase` for structs/interfaces, `camelCase` for vars, `ALL_CAPS` for constants; exported symbols are Capitalized
+- **Error handling**: Return Go `error` type; wrap or enrich errors with context (e.g., `fmt.Errorf`); log errors with `logs.Error`/`logs.Fatal`
+- **JSON struct tags**: Always used for API inputs/outputs
+- **Tests**: Standard `_test.go` files; assertions via Go testing or testify if added
+- **Env/config**: Managed via `env/` package and `.env` file
+
+## 3. Project Structure
+- App code is under `cmd/`, `pkg/`, `domains/`, `router/`
+- DB/migrations/seed in `db/`, utility code in `pkg/utils/`
+
+No Cursor or Copilot rules present. If new lint, type, or style guidelines are added, update this file accordingly.

.opencode/opencode.db

@@ -0,0 +1,16 @@
+-- migrate:up
+CREATE TABLE jobs (
+    id SERIAL PRIMARY KEY,
+    type VARCHAR(255) NOT NULL,
+    payload JSON,
+    state VARCHAR(16) NOT NULL CHECK (state IN ('pending', 'started', 'finished', 'failed')),
+    error_msg TEXT,
+    attempts INT NULL,
+    available_at TIMESTAMP NULL,
+    created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    started_at TIMESTAMP NULL,
+    finished_at TIMESTAMP NULL
+);
+
+-- migrate:down
+DROP TABLE IF EXISTS jobs;

.opencode/opencode.db-shm

@@ -0,0 +1,102 @@
+# GoPlate Documentation
+
+Welcome to **GoPlate** - a modern, production-ready Go boilerplate for building REST APIs with best practices built-in.
+
+## What is GoPlate?
+
+GoPlate is a comprehensive Go boilerplate that provides everything you need to build robust REST APIs quickly and efficiently. It combines the power of modern Go frameworks with battle-tested patterns and tools to give you a solid foundation for your next project.
+
+## Key Features
+
+### 🔥 High Performance
+- Built on **Fiber** framework - one of the fastest HTTP frameworks for Go
+- Optimized for high throughput and low latency
+- Efficient memory usage and minimal overhead
+
+### 🗄️ Database Integration
+- **GORM** ORM with support for MySQL and PostgreSQL
+- Database migrations and seeders
+- Connection pooling and optimization
+- Automatic model generation
+
+### 🔐 Security First
+- JWT authentication middleware
+- Request validation with `go-playground/validator`
+- CORS support
+- Basic authentication for admin endpoints
+- Environment-based configuration
+
+### 🛠️ Developer Experience
+- Hot reload development server
+- Comprehensive CLI tools via Makefile
+- Code generation for models, DTOs, and more
+- Structured logging with file rotation
+- Test coverage reporting
+
+### 📦 Clean Architecture
+- Well-organized project structure following Go conventions
+- Separation of concerns
+- Modular design for easy maintenance
+- Scalable codebase organization
+
+### ⏰ Background Processing
+- In-memory task queue with worker pools
+- CRON-based job scheduling
+- Asynchronous task processing
+- Configurable worker concurrency
+
+## Quick Overview
+
+```go
+// Simple API endpoint example
+func (c *Controller) GetUsers(ctx *fiber.Ctx) error {
+    users, err := c.userService.GetAll()
+    if err != nil {
+        return ctx.Status(500).JSON(fiber.Map{
+            "error": "Failed to fetch users",
+        })
+    }
+    
+    return ctx.JSON(fiber.Map{
+        "success": true,
+        "data": users,
+    })
+}
+```
+
+## Architecture Highlights
+
+- **MVC Pattern**: Clean separation between Models, Views, and Controllers
+- **Middleware Stack**: Authentication, CORS, logging, and error handling
+- **Service Layer**: Business logic abstraction
+- **Repository Pattern**: Data access abstraction
+- **Dependency Injection**: Loose coupling between components
+
+## Use Cases
+
+GoPlate is perfect for:
+
+- **REST APIs**: Build scalable web APIs
+- **Microservices**: Create lightweight, focused services  
+- **Backend Services**: Power mobile and web applications
+- **Data Processing**: Handle background tasks and scheduled jobs
+- **Prototyping**: Quickly validate ideas with a solid foundation
+
+## Getting Started
+
+Ready to build something amazing? Let's get you started:
+
+1. **[Quick Start](/quick-start)** - Get up and running in minutes
+2. **[Installation](/installation)** - Detailed installation guide
+3. **[Configuration](/configuration)** - Configure your environment
+4. **[Project Structure](/project-structure)** - Understand the codebase
+
+## Community & Support
+
+- **GitHub**: [sheenazien8/goplate](https://github.com/sheenazien8/goplate)
+- **Issues**: Report bugs and request features
+- **Discussions**: Ask questions and share ideas
+
+---
+
+**Ready to start building?** Head over to the [Quick Start](/quick-start) guide!

.opencode/opencode.db-wal

@@ -0,0 +1,15 @@
+# GoPlate
+
+> A modern, production-ready Go boilerplate for building REST APIs with best practices built-in.
+
+- 🔥 **Fast** - Built on Fiber framework with high performance
+- 🗄️ **Database Ready** - GORM with MySQL/PostgreSQL support
+- 🔐 **Secure** - JWT authentication and validation built-in
+- 🛠️ **Developer Friendly** - Hot reload, migrations, and code generation
+- 📦 **Clean Architecture** - Well-organized project structure
+- ⏰ **Background Tasks** - Queue system and CRON scheduler
+
+[GitHub](https://github.com/sheenazien8/goplate)
+[Get Started](/quick-start)
+
+![color](#f0f0f0)

AGENTS.md

@@ -0,0 +1,5 @@
+- [Home](/)
+- [Quick Start](/quick-start)
+- [API Reference](/api-reference)
+- [Examples](/examples)
+- [GitHub](https://github.com/sheenazien8/goplate)

db/migrations/20250609004425_create_jobs_table.sql

@@ -0,0 +1,43 @@
+- **Getting Started**
+  - [Introduction](/)
+  - [Quick Start](/quick-start)
+  - [Installation](/installation)
+  - [Configuration](/configuration)
+
+- **Development**
+  - [Project Structure](/project-structure)
+  - [Database](/database)
+  - [Routing](/routings)
+  - [DTOs & Validation](/validation-and-dto)
+
+- **Features**
+  - [Authentication](/authentication)
+  - [Logging](/logging)
+  - [Background Tasks](/background-tasks)
+  - [Task Scheduler](/task-scheduler)
+  - [Error Handling](/error-handling)
+
+- **API Reference**
+  - [Endpoints](/api-reference)
+  - [Request/Response](/request-response)
+  - [Status Codes](/status-codes)
+
+- **Deployment**
+  - [Production Setup](/production-setup)
+  - [Docker](/docker)
+  - [Environment Variables](/environment-variables)
+<!---->
+<!-- - **Advanced** -->
+<!--   - [Code Generation](/code-generation) -->
+<!--   - [Testing](/testing) -->
+<!--   - [Performance](/performance) -->
+<!--   - [Best Practices](/best-practices) -->
+
+- **Examples**
+  - [Basic CRUD](/examples/crud)
+  - [Authentication Flow](/examples/auth)
+  - [Background Jobs](/examples/jobs)
+
+- **Contributing**
+  - [Development Setup](/contributing/setup)
+  - [Guidelines](/contributing/guidelines)