Skip to content

docs: modernize architecture, add REST API reference, and sync test suite counts #1930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
komalharshita merged 2 commits into from
Sep 19, 2026
+990 −223
Merged

docs: modernize architecture, add REST API reference, and sync test suite counts #1930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
772554c
docs: modernize architecture, add REST API reference, and sync test s…
santusht06 Aug 24, 2026
66a79f9
docs(api): sync API reference with backend routes, schemas, and param…
santusht06 Sep 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,18 @@ Closes #

1. Clone this branch: `git checkout your-branch-name`
2. Install dependencies: `pip install -r requirements.txt`
3. Run the app: `python app.py`
4. Open http://127.0.0.1:5000 and...
5. Run the tests: `python tests/test_basic.py`
3. Run the app: `PORT=5001 python src/app.py`
4. Open http://localhost:5001 and verify functionality
5. Run the tests: `pytest tests/`

Expected test output:
```
27 passed, 0 failed out of 27 tests
660+ passed in tests/
```

## Test Results [required]

<!-- Paste the full output of python tests/test_basic.py -->
<!-- Paste the full output of pytest tests/ -->

```
paste output here
Expand All @@ -82,7 +82,7 @@ paste output here

- [ ] I have read [CONTRIBUTING.md](../CONTRIBUTING.md) and followed all guidelines
- [ ] My branch name follows the convention: `feat/`, `fix/`, `docs/`, `data/`, `style/`, `test/`
- [ ] I have run `python tests/test_basic.py` and all 27 tests pass
- [ ] I have run `pytest tests/` and all test suites pass
- [ ] I have run `flake8 .` locally and there are no errors
- [ ] I have not introduced any `print()` or `console.log()` debug statements
- [ ] Every new function I wrote has a docstring
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[![Python](https://img.shields.io/badge/Python-3.8%2B-2335c2?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/)
[![Flask](https://img.shields.io/badge/Flask-3.0-0f172a?style=for-the-badge&logo=flask&logoColor=white)](https://flask.palletsprojects.com/)
[![MIT License](https://img.shields.io/badge/License-MIT-fbbf24?style=for-the-badge)](LICENSE)
[![Tests](https://img.shields.io/badge/Tests-27_Passing-22c55e?style=for-the-badge&logo=checkmarx&logoColor=white)](#quick-start)
[![Tests](https://img.shields.io/badge/Tests-660%2B_Passing-22c55e?style=for-the-badge&logo=checkmarx&logoColor=white)](#quick-start)
[![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-7c3aed?style=for-the-badge&logo=git&logoColor=white)](CONTRIBUTING.md)
[![GSSoC](https://img.shields.io/badge/GSSoC-2026-fbbf24?style=for-the-badge&logo=opensourceinitiative&logoColor=0f1560)](https://gssoc.girlscript.tech/)

Expand Down Expand Up @@ -178,13 +178,13 @@ python src/app.py
Run the test suite:

```bash
python tests/test_basic.py
pytest tests/
```

Expected output:

```bash
All tests passed
================= 660+ passed in tests/ =================
```

---
Expand Down
45 changes: 45 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# DevPath Documentation Portal

Welcome to the DevPath technical documentation suite. Whether you are an open-source contributor, architect, or developer exploring the API, you will find detailed guides and specifications below.

---

## 📚 Documentation Index

| Guide | Description | Target Audience |
|---|---|---|
| **[System Architecture](architecture.md)** | Detailed system components, Blueprint design, security model, and request lifecycles. | Contributors & Maintainers |
| **[REST API Reference](api_reference.md)** | Complete endpoint specifications, request payloads, schemas, and responses. | Integrators & Frontend Developers |
| **[Contribution Guide](contribution_guide.md)** | Step-by-step development setup, branch naming, testing, and PR guidelines. | GSSoC & Open Source Contributors |
| **[Project Overview](project_overview.md)** | Mission, problem statement, and algorithm scoring design. | All Developers |
| **[Security Policy](security.md)** | Security architecture, vulnerability reporting, and best practices. | Security Researchers & Deployers |
| **[Frequently Asked Questions](faq.md)** | Common troubleshooting tips and implementation questions. | General |

---

## 🚀 Quick Technical Summary

- **Backend**: Python 3.8+ & Flask 3.1
- **Database**: SQLite with SQLAlchemy ORM (auto-seeded from `data/projects.json`)
- **Authentication**: Authlib (OAuth 2.0 with GitHub integration)
- **Frontend**: Vanilla JavaScript (ES6+), Semantic HTML5, Glassmorphism CSS design system
- **Security**: Strict CSP, Flask-WTF CSRF tokens, secure session cookie policies
- **Testing**: Automated `pytest` suite with **660+ passing test cases**

---

## 🛠️ Running Locally

```bash
# 1. Create and activate virtual environment
python3 -m venv venv
source venv/bin/activate

# 2. Install dependencies
pip install -r requirements.txt

# 3. Start development server
PORT=5001 python src/app.py
```

Then visit **http://localhost:5001** in your browser.
Loading