Initial commit: Complete project-bootstrap tool

- Bootstrap script for creating monorepo projects
- FastAPI backend templates with uv, ruff, mypy, pytest
- React frontend templates with TypeScript, ESLint, Prettier
- Docker Compose setup with backend, frontend, and database
- 9 development and CI scripts
- Gitea Actions CI/CD workflows
- Comprehensive documentation (8 files)
- 45 template files for complete project structure
- Automated verification script (all tests pass)
- Based on coding-agent-rules standards
This commit is contained in:
2025-10-15 21:34:08 -04:00
commit 8dd4f0ca63
56 changed files with 3979 additions and 0 deletions

View File

@@ -0,0 +1,35 @@
# API Changelog
All notable changes to the API will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- Initial API setup with FastAPI
- Health check endpoint
- Root endpoint
### Changed
- N/A
### Deprecated
- N/A
### Removed
- N/A
### Fixed
- N/A
### Security
- N/A
## [0.1.0] - YYYY-MM-DD
### Added
- Initial release
- Basic project structure
- FastAPI application setup

View File

@@ -0,0 +1,79 @@
# API Documentation
## Overview
The API is built with FastAPI and follows REST principles.
## Base URL
- **Development**: `http://localhost:8000`
- **API Prefix**: `/api/v1`
## Interactive Documentation
FastAPI provides automatic interactive API documentation:
- **Swagger UI**: http://localhost:8000/docs
- **ReDoc**: http://localhost:8000/redoc
## Authentication
(Add authentication details here when implemented)
## Endpoints
### Health Check
```
GET /health
```
Returns the health status of the API.
**Response:**
```json
{
"status": "healthy"
}
```
### Root
```
GET /
```
Returns basic API information.
**Response:**
```json
{
"message": "Welcome to the API",
"version": "0.1.0"
}
```
## Error Responses
All error responses follow this format:
```json
{
"detail": "Error message here"
}
```
### Common Status Codes
- **200 OK** - Request succeeded
- **201 Created** - Resource created successfully
- **400 Bad Request** - Invalid request data
- **401 Unauthorized** - Authentication required
- **403 Forbidden** - Insufficient permissions
- **404 Not Found** - Resource not found
- **422 Unprocessable Entity** - Validation error
- **500 Internal Server Error** - Server error
## Changelog
See [CHANGELOG.md](./CHANGELOG.md) for API changes and migration notes.