80 lines
2.3 KiB
Markdown
80 lines
2.3 KiB
Markdown
# 📚 ap_ds Code Repository System
|
|
|
|
> A self-hosted **code hosting & documentation platform** — code browsing, releases, version downloads, feedback, and admin management.
|
|
|
|
**ap_ds Code Repository System** is a Flask-based platform for hosting and showcasing code. It features code/file browsing with syntax highlighting, Markdown rendering, release management with version downloads (ZIP / TAR / WHL), search, user feedback, and a full admin dashboard.
|
|
|
|
---
|
|
|
|
## ✨ Features
|
|
|
|
| Feature | Description |
|
|
|---------|-------------|
|
|
| 📂 **Code Browser** | Browse repository files / directories |
|
|
| 👁️ **Code View** | Syntax highlighting (Pygments) |
|
|
| 📄 **Markdown View** | Render Markdown documents |
|
|
| 📦 **Release Downloads** | Download version archives (ZIP / TAR / WHL) |
|
|
| 🔖 **Releases Page** | List versions & release notes |
|
|
| 🔍 **Search** | Search across the repository |
|
|
| 💬 **Feedback** | Users submit feedback; admin manages it |
|
|
| 🛠️ **Admin Panel** | Login, dashboard, branches, version upload, feedback management |
|
|
|
|
---
|
|
|
|
## 🔌 Routes
|
|
|
|
| Route | Description |
|
|
|-------|-------------|
|
|
| `/` | Homepage |
|
|
| `/code` | Code browsing |
|
|
| `/browse/<dir_path>` | Browse a directory |
|
|
| `/view/<file_path>` | View a file (syntax highlight) |
|
|
| `/download/<file_path>` | Download a file |
|
|
| `/download/zip|tar|whl` | Download version archives |
|
|
| `/releases` | Releases page |
|
|
| `/search` | Search |
|
|
| `/feedback` | Submit feedback |
|
|
| `/admin/*` | Admin management |
|
|
|
|
---
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Prerequisites
|
|
- Python 3.8+
|
|
- `flask`, `markdown`, `pygments`, `markupsafe`, `werkzeug`
|
|
|
|
### Install & Run
|
|
|
|
```bash
|
|
pip install flask markdown pygments markupsafe werkzeug
|
|
|
|
python app.py
|
|
```
|
|
|
|
Then open the site in your browser.
|
|
|
|
---
|
|
|
|
## 📁 Project Structure
|
|
|
|
```
|
|
AP_DS_GIT_CODE/
|
|
├── app.py # Main Flask application
|
|
├── static/
|
|
│ ├── css.css # Stylesheet
|
|
│ └── fonts/ # Icon fonts
|
|
├── templates/ # 15 HTML templates
|
|
│ ├── index.html # Homepage
|
|
│ ├── code_browser.html # Code browser
|
|
│ ├── admin_*.html # Admin pages
|
|
│ └── ...
|
|
└── README.md # This document
|
|
```
|
|
|
|
---
|
|
|
|
## 📄 License
|
|
|
|
This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
|