Initial commit

README.md

@@ -1,3 +1,23 @@
-# fastapi-template
+# Omukk FastAPI Template
 
-Template files for all fastapi projects
+Template repository for all FastAPI backend projects developed by Omukk.
+
+## Components
+- Basic FastAPI dependencies
+- Docker and Docker Compose for easier testing
+- Alembic configuration for database migrations
+- Initial codebase to start from
+
+## Using this template
+
+1. **Create a new repository from this template**:
+   - In Omukk Repos, navigate to [this repository](https://git.omukk.dev/pptx704/fastapi-template)
+   - Click the "Use this template" button at the top of the page
+   - Choose "Create a new repository"
+   - Fill in your new repository details and click "Create Repository"
+
+2. **Clone your new repository**:
+   ```bash
+   git clone git@git.omukk.dev/<username>/<repo>.git
+   cd <repo>
+   ```