feat: implement blog project with CI pipeline
This commit is contained in:
28
docs/index.md
Normal file
28
docs/index.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Blog API
|
||||
|
||||
Welcome to the Blog API documentation.
|
||||
|
||||
## Features
|
||||
|
||||
- FastAPI-based REST API
|
||||
- Python 3.13+
|
||||
- Async support
|
||||
- Type hints throughout
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
uv sync
|
||||
|
||||
# Run development server
|
||||
uv run python -m app.main
|
||||
```
|
||||
|
||||
## API Endpoints
|
||||
|
||||
See [API Reference](api/endpoints.md) for detailed endpoint documentation.
|
||||
|
||||
## Development
|
||||
|
||||
See [Development Guide](development/setup.md) for setup instructions.
|
||||
Reference in New Issue
Block a user