Skip to content

Commit 3dc3b3c

Browse files
committed
docs: update README with live URLs, stack, and setup instructions
1 parent 443d8dd commit 3dc3b3c

1 file changed

Lines changed: 64 additions & 7 deletions

File tree

README.md

Lines changed: 64 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,72 @@
11
# Spotter ELD
22

3-
Trip planner for property-carrying truck drivers that auto-generates FMCSA-compliant ELD daily logs and route maps.
3+
Trip planner for property-carrying truck drivers that auto-generates
4+
FMCSA-compliant ELD daily logs and route maps from a single trip input.
45

5-
**Status:** 🚧 In development
6+
**Live Demo:** https://spotter-eld-gamma.vercel.app
7+
8+
## What It Does
9+
10+
Enter four fields — current location, pickup, dropoff, and cycle hours
11+
used — and get back a fully planned, legally-compliant trip schedule with:
12+
13+
- Interactive route map with mandatory stop markers
14+
- Day-by-day timeline view with color-coded duty status
15+
- FMCSA Driver's Daily Log sheets (faithful paper form replica)
16+
- Automatic HOS rule enforcement (11h limit, 14h window, 30-min break,
17+
70-hour cycle, 34-hour restart)
618

719
## Stack
820

9-
- **Backend:** Django + DRF
10-
- **Frontend:** React + Vite + Tailwind
11-
- **Maps & routing:** Leaflet + OpenRouteService
21+
- **Backend:** Django 5 + Django REST Framework → Railway
22+
- **Frontend:** React 18 + Vite + TypeScript + Tailwind CSS → Vercel
23+
- **Maps:** Leaflet + OpenRouteService
24+
- **Testing:** pytest (26 tests, all passing)
25+
26+
## Architecture
27+
28+
The HOS simulator (`backend/simulator/`) is pure Python with zero Django
29+
dependency. It takes a `TripInput` and returns a `TripPlanResult`
30+
Django is a thin REST wrapper around it.
31+
32+
See `docs/` for full specifications:
33+
- `BRIEF.md` — product vision
34+
- `HOS_RULES.md` — FMCSA rules enforced
35+
- `ALGORITHM.md` — simulation decisions and edge cases
36+
37+
## Running Locally
38+
39+
**Backend:**
40+
```bash
41+
cd backend
42+
pip install -r requirements.txt
43+
cp .env.example .env # add your ORS_API_KEY
44+
python manage.py migrate
45+
python manage.py runserver
46+
```
47+
48+
**Frontend:**
49+
```bash
50+
cd frontend
51+
npm install
52+
cp .env.example .env.local # set VITE_API_URL=http://localhost:8000
53+
npm run dev
54+
```
55+
56+
**Tests:**
57+
```bash
58+
cd backend
59+
pytest simulator/tests/ -v
60+
```
61+
62+
## Known Limitations
63+
64+
- Sleeper berth 7+3 split not implemented (full 10h reset only)
65+
- Cycle hours use flat balance (no rolling 8-day window falloff)
66+
- Map stop positions use linear interpolation (not real highway routing)
67+
- Home terminal timezone hardcoded to America/Chicago
1268

13-
## Project structure
69+
## Assessment Notes
1470

15-
Product goals, constraints, and scope live in the project brief: [docs/BRIEF.md](docs/BRIEF.md).
71+
Built for Spotter AI Full Stack Developer assessment.
72+
Time spent: ~16 hours over 2 days.

0 commit comments

Comments
 (0)