Documentation : repo enhancement (#496)

nishika26 · web-flow · commit de8d9b8a4354 · 2025-12-22T18:02:13.000+05:30
* Documentation : repo MDs enhancement and adding enhancement template
diff --git a/.env.example b/.env.example
@@ -2,14 +2,8 @@
 
 # This would be set to the production domain with an env var on deployment
 
-# used by Traefik to transmit traffic and aqcuire TLS certificates
-
 DOMAIN=localhost
 
-# To test the local Traefik config
-
-# DOMAIN=localhost.tiangolo.com
-
 # Environment: "development", "testing", "staging", "production"
 
 ENVIRONMENT=development
diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md
@@ -0,0 +1,20 @@
+---
+name: Enhancement request
+about: Suggest an improvement to existing codebase
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the current behavior**
+A clear description of how it currently works and what the limitations are.
+
+**Describe the enhancement you'd like**
+A clear and concise description of the improvement you want to see.
+
+**Why is this enhancement needed?**
+Explain the benefits (e.g., performance, usability, maintainability, scalability).
+
+**Additional context**
+Add any other context, metrics, screenshots, or examples about the enhancement here.
diff --git a/.github/workflows/cd-production.yml b/.github/workflows/cd-production.yml
@@ -1,4 +1,4 @@
-name: Deploy AI Platform to ECS Production
+name: Deploy Kaapi to ECS Production
 
 on:
   push:
diff --git a/.github/workflows/cd-staging.yml b/.github/workflows/cd-staging.yml
@@ -1,4 +1,4 @@
-name: Deploy AI Platform to ECS
+name: Deploy Kaapi to ECS
 
 on:
   push:
diff --git a/.github/workflows/continuous_integration.yml b/.github/workflows/continuous_integration.yml
@@ -1,4 +1,4 @@
-name: AI Platform CI
+name: Kaapi CI
 
 on:
   push:
@@ -22,7 +22,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ["3.11.7"]
+        python-version: ["3.12"]
         redis-version: [6]
 
     steps:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,13 +1,13 @@
-# Contributing to Tech4Dev AI Platform
+# Contributing to Kaapi
 
-Thank you for considering contributing to **Tech4Dev AI Platform**! We welcome contributions of all kinds, including bug reports, feature requests, documentation improvements, and code contributions.
+Thank you for considering contributing to **Kaapi**! We welcome contributions of all kinds, including bug reports, feature requests, documentation improvements, and code contributions.
 
 ---
 
 ## 📌 Getting Started
 To contribute successfully, you must first set up the project on your local machine. Please follow the instructions outlined in the project's README to configure the repository and begin your contributions.
 
-Before you proceed, **make sure to check the repository's [README](https://github.com/ProjectTech4DevAI/ai-platform/blob/main/backend/README.md) for a comprehensive overview of the project's backend and detailed setup guidelines.**
+Before you proceed, **make sure to check the repository's [README](https://github.com/ProjectTech4DevAI/kaapi-backend/blob/main/backend/README.md) for a comprehensive overview of the project's backend and detailed setup guidelines.**
 
 ---
 
@@ -17,10 +17,18 @@ Before you proceed, **make sure to check the repository's [README](https://githu
 1. Click the **Fork** button on the top right of this repository.
 2. Clone your forked repository:
 ```
-git clone https://github.com/{username}/ai-platform.git
-cd ai-platform
+git clone https://github.com/{username}/kaapi-backend.git
+cd kaapi-backend
 ```
 
+### Check for Existing Issues
+Before you start working on a contribution:
+1. **Check if an issue exists** for the bug or feature you want to work on in the [Issues](https://github.com/ProjectTech4DevAI/kaapi-backend/issues) section.
+2. **If no issue exists**, create one first using the templates present:
+   - For bugs: Use the bug report template
+   - For enhancements: Use the enhancement request template
+   - For features: Create a feature request issue
+
 ### Create a Branch
 • Always work in a new branch based on main.
 • For branch name, follow this convention: ``type/one-line-description``
@@ -30,12 +38,9 @@ cd ai-platform
    - enhancement
    - bugfix
    - feature
-
-
  ```
  git checkout -b type/one-line-description
  ```
-
 ### Make and Test Changes
 1. Adhere to the project's established coding style for consistency.
 2. Make sure the code adheres to best practices.
@@ -60,7 +65,7 @@ git commit -m "one liner for the commit"
 • For PR name, follow this convention:
    ``Module Name: One liner of changes``
 
-• Don't forget to link the PR to the issue if you are solving one.
+• Don't forget to link the PR to the issue.
 
 • Push your changes to GitHub:
 ```
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
-# AI Platform
+# Kaapi
 
 [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
-![](https://github.com/ProjectTech4DevAI/ai-platform/workflows/Continuous%20Integration/badge.svg)
-[![Code coverage badge](https://img.shields.io/codecov/c/github/ProjectTech4DevAI/ai-platform/staging.svg)](https://codecov.io/gh/ProjectTech4DevAI/ai-platform/branch/staging)
-![GitHub issues](https://img.shields.io/github/issues-raw/ProjectTech4DevAI/ai-platform)
-[![codebeat badge](https://codebeat.co/badges/dd951390-5f51-4c98-bddc-0b618bdb43fd)](https://codebeat.co/projects/github-com-ProjectTech4DevAI/ai-platform-staging)
-[![Commits](https://img.shields.io/github/commit-activity/m/ProjectTech4DevAI/ai-platform)](https://img.shields.io/github/commit-activity/m/ProjectTech4DevAI/ai-platform)
+![](https://github.com/ProjectTech4DevAI/kaapi-backend/workflows/Continuous%20Integration/badge.svg)
+[![Code coverage badge](https://img.shields.io/codecov/c/github/ProjectTech4DevAI/kaapi-backend/staging.svg)](https://codecov.io/gh/ProjectTech4DevAI/kaapi-backend/branch/staging)
+![GitHub issues](https://img.shields.io/github/issues-raw/ProjectTech4DevAI/kaapi-backend)
+[![codebeat badge](https://codebeat.co/badges/dd951390-5f51-4c98-bddc-0b618bdb43fd)](https://codebeat.co/projects/github-com-ProjectTech4DevAI/kaapi-backend-staging)
+[![Commits](https://img.shields.io/github/commit-activity/m/ProjectTech4DevAI/kaapi-backend)](https://img.shields.io/github/commit-activity/m/ProjectTech4DevAI/kaapi-backend)
 
 ## Pre-requisites
 
diff --git a/backend/README.md b/backend/README.md
@@ -1,4 +1,4 @@
-# FastAPI Project - Backend
+# Kaapi - Backend
 
 ## Requirements
 
@@ -27,13 +27,15 @@ $ source .venv/bin/activate
 
 Make sure your editor is using the correct Python virtual environment, with the interpreter at `backend/.venv/bin/python`.
 
-Modify or add SQLModel models for data and SQL tables in `./backend/app/models.py`, API endpoints in `./backend/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/crud.py`.
+Modify or add SQLModel models for data and SQL tables in `./backend/app/models/`, API endpoints in `./backend/app/api/`, CRUD (Create, Read, Update, Delete) utils in `./backend/app/crud/`.
 
-## VS Code
+## Seed Database (Optional)
 
-There are already configurations in place to run the backend through the VS Code debugger, so that you can use breakpoints, pause and explore variables, etc.
+For local development, seed the database with baseline data:
 
-The setup is also already configured so you can run the tests through the VS Code Python tests tab.
+```console
+$ uv run python -m app.seed_data.seed_data
+```
 
 ## Docker Compose Override
 
@@ -91,6 +93,22 @@ Nevertheless, if it doesn't detect a change but a syntax error, it will just sto
 
 ## Backend tests
 
+### Setup Test Environment
+
+Before running tests, create a test environment configuration:
+
+1. Copy the test environment template:
+```console
+$ cp .env.test.example .env.test
+```
+
+2. Update `.env.test` with test-specific settings:
+   - Set `ENVIRONMENT=testing`
+   - Configure a separate test database (recommended). Using a separate
+     database prevents tests from affecting your development data.
+
+### Run Tests
+
 To test the backend run:
 
 ```console
@@ -133,7 +151,7 @@ Make sure you create a "revision" of your models and that you "upgrade" your dat
 $ docker compose exec backend bash
 ```
 
-* Alembic is already configured to import your SQLModel models from `./backend/app/models.py`.
+* Alembic is already configured to import your SQLModel models from `./backend/app/models/`.
 
 * After changing a model (for example, adding a column), inside the container, create a revision, e.g.:
 
diff --git a/deployment.md b/deployment.md
diff --git a/development.md b/development.md

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Deploy AI Platform to ECS Production`
	`1`	`+name: Deploy Kaapi to ECS Production`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`push:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Deploy AI Platform to ECS`
	`1`	`+name: Deploy Kaapi to ECS`
`2`	`2`
`3`	`3`	`on:`
`4`	`4`	`push:`