@@ -109,73 +109,3 @@ Endpoints:
109109 - And more...
110110- Proper error handling (400/403/404)
111111- File metadata (size, language, path)
112-
113- Endpoints:
114- - ` GET /api/source ` - Read source files with syntax detection
115-
116- #### Project Structure
117- - ` internal/services/ ` - Business logic layer
118- - ` internal/handlers/ ` - HTTP request/response handling
119- - ` internal/routes/ ` - Route registration and Swagger docs
120- - ` docs/ ` - Auto-generated Swagger specification
121- - ` Makefile ` - Build automation and common tasks
122- - ` go.mod ` - Dependency management
123- - ` README.md ` - Project documentation
124- - ` DEVELOPMENT.md ` - Development setup guide
125-
126- #### DevOps & Tooling
127- - Makefile with targets:
128- - ` make install ` - Install dependencies and tools
129- - ` make build ` - Build Go binary
130- - ` make dev ` - Run with hot-reload (air)
131- - ` make run ` - Run compiled binary
132- - ` make test ` - Run tests
133- - ` make swagger ` - Generate Swagger docs
134- - GitHub Actions CI/CD pipeline
135- - Docker support (Dockerfile included)
136- - ` .env.example ` - Environment configuration template
137-
138- #### Documentation
139- - ` README.md ` - Quick start and API reference
140- - ` DEVELOPMENT.md ` - Development environment setup
141- - ` BACKEND_MIGRATION.md ` - Migration guide from Next.js
142- - ` BACKEND_SETUP.md ` - Detailed setup instructions
143- - ` CHANGELOG.md ` - This file
144-
145- ### Technical Details
146-
147- #### Dependencies
148- - ` github.com/gofiber/fiber/v2 ` v2.52.0 - Web framework
149- - ` github.com/swaggo/swag ` v1.16.0 - Swagger documentation
150- - ` github.com/swaggo/files ` v1.0.1 - Swagger UI files
151- - ` github.com/joho/godotenv ` v1.5.1 - Environment variables
152-
153- #### Architecture
154- - ** Service Pattern** : Business logic encapsulated in services
155- - ** Handler Pattern** : HTTP concerns handled separately
156- - ** Middleware** : CORS, logging, error handling
157- - ** Error Handling** : Consistent error responses with proper status codes
158- - ** Caching** : In-memory cache with TTL (ready for Redis migration)
159- - ** API Versioning** : Prepared for future API versioning
160-
161- ### Performance Features
162- - In-memory caching with intelligent TTL management
163- - Efficient filtering and sorting algorithms
164- - Pagination to prevent large response payloads
165- - Relevance-based search scoring
166-
167- ### Security Features
168- - CORS enabled for development (can be configured)
169- - Path validation for file serving
170- - Input validation on all endpoints
171- - Structured logging for debugging
172- - Proper HTTP status codes for security (403, 404, etc.)
173-
174- ### Known Limitations
175- - In-memory cache (no persistence across restarts)
176- - No authentication/authorization yet
177- - Search endpoint uses Next.js backend (to be migrated)
178- - No rate limiting
179- - Health check is basic (ready to enhance)
180-
181- ---
0 commit comments