Skip to content

Commit 8bb6e23

Browse files
committed
docs(readme): add project badges and align repository map
1 parent 10dbccc commit 8bb6e23

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# ReturnHub
22

3+
[![CI Pipeline](https://img.shields.io/github/actions/workflow/status/AAdewunmi/Returns-Escalation-Predictor-Project/ci.yml?branch=main)](https://github.com/AAdewunmi/Returns-Escalation-Predictor-Project/actions/workflows/ci.yml)
4+
[![Code Style - Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://black.readthedocs.io/)
5+
[![Lint - Ruff](https://img.shields.io/badge/lint-ruff-000000.svg)](https://docs.astral.sh/ruff/)
6+
[![Python](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/)
7+
[![Django](https://img.shields.io/badge/django-5.x-0C4B33.svg)](https://www.djangoproject.com/)
8+
[![DRF](https://img.shields.io/badge/DRF-3.15-red.svg)](https://www.django-rest-framework.org/)
9+
[![PostgreSQL](https://img.shields.io/badge/postgresql-16-336791.svg)](https://www.postgresql.org/)
10+
[![Docker](https://img.shields.io/badge/docker-enabled-2496ED.svg)](https://www.docker.com/)
11+
[![Docker Compose](https://img.shields.io/badge/docker%20compose-supported-2496ED.svg)](https://docs.docker.com/compose/)
12+
[![License](https://img.shields.io/github/license/AAdewunmi/Returns-Escalation-Predictor-Project)](https://github.com/AAdewunmi/Returns-Escalation-Predictor-Project/blob/main/LICENSE)
13+
[![Coverage Status](https://codecov.io/gh/AAdewunmi/Returns-Escalation-Predictor-Project/branch/main/graph/badge.svg)](https://codecov.io/gh/AAdewunmi/Returns-Escalation-Predictor-Project)
14+
315
ReturnHub is a Django 5 application for managing online-retail return cases across customer, merchant, ops, and admin roles. The project combines server-rendered workflow surfaces with DRF APIs, a service-layer workflow core, persisted audit events, and artifact-backed escalation-risk scoring.
416

517
## Feature-complete state
@@ -236,7 +248,11 @@ docker compose exec -T web python manage.py retrain_baseline_model --seed 7 --ro
236248

237249
```text
238250
.
251+
├── .dockerignore
252+
├── .env.example
239253
├── .github/
254+
├── .gitattributes
255+
├── .gitignore
240256
├── accounts/
241257
├── analytics/
242258
├── api/
@@ -245,11 +261,13 @@ docker compose exec -T web python manage.py retrain_baseline_model --seed 7 --ro
245261
├── config/
246262
├── console/
247263
├── core/
264+
├── docker/
248265
├── docs/
249266
│ ├── api/
250267
│ ├── ml/
251268
│ ├── sprint-runbook/
252269
│ └── ui/
270+
├── infra/
253271
├── ml/
254272
├── ml_artifacts/
255273
├── requirements/
@@ -259,12 +277,17 @@ docker compose exec -T web python manage.py retrain_baseline_model --seed 7 --ro
259277
├── tests/
260278
├── ui/
261279
├── Dockerfile
280+
├── Dockerfile.prod
281+
├── LICENSE
262282
├── Makefile
263283
├── README.md
264284
├── RUNBOOK.md
265285
├── codecov.yml
286+
├── docker-compose.prod.yml
266287
├── docker-compose.yml
288+
├── gunicorn.conf.py
267289
├── manage.py
290+
├── production.env.example
268291
├── pyproject.toml
269292
└── web/
270293
```

0 commit comments

Comments
 (0)