Skip to content

Commit 4ef2f8c

Browse files
committed
docs: update roadmap and add deployment instructions
1 parent ca7b14f commit 4ef2f8c

1 file changed

Lines changed: 34 additions & 8 deletions

File tree

README.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,29 @@ PYTHONPATH=src poetry run python scripts/cte_cli.py \
266266

267267
---
268268

269+
## Deploy Your Own
270+
271+
### Streamlit Cloud (Free)
272+
273+
1. Fork this repo
274+
2. Go to [share.streamlit.io](https://share.streamlit.io)
275+
3. Connect your GitHub and select the repo
276+
4. Set:
277+
- Main file: `scripts/cte_app.py`
278+
- Python version: 3.11
279+
5. Add secret `OPENAI_API_KEY` (optional, for LLM features)
280+
281+
Your dashboard will be live at `https://your-app.streamlit.app`
282+
283+
### Docker
284+
285+
```bash
286+
docker compose up --build
287+
# Open http://localhost:8501
288+
```
289+
290+
---
291+
269292
## Limitations & Responsible Use
270293

271294
- **Not a hiring tool**: CTE is for self-reflection and career exploration, not employment decisions
@@ -289,14 +312,17 @@ PYTHONPATH=src poetry run python scripts/cte_cli.py \
289312

290313
## Roadmap
291314

292-
- [x] **Phase 1**: Data cleaning pipeline
293-
- [x] **Phase 2**: Feature engineering
294-
- [x] **Phase 3**: Baseline modeling
295-
- [x] **Phase 4**: Synthetic data generator
296-
- [x] **Phase 5**: Test suite
297-
- [ ] **Phase 6**: FastAPI endpoints
298-
- [ ] **Phase 7**: Public dataset validation
299-
- [ ] **Phase 8**: Multi-user support
315+
- [x] Data cleaning pipeline
316+
- [x] Feature engineering
317+
- [x] Baseline modeling (Ridge, RF, GBM)
318+
- [x] NLP sentiment analysis
319+
- [x] Job-fit scoring system
320+
- [x] Streamlit dashboard
321+
- [x] Synthetic data generator
322+
- [x] Test suite (56 tests)
323+
- [x] CI/CD pipeline
324+
- [ ] Public dataset validation
325+
- [ ] FastAPI endpoints
300326

301327
---
302328

0 commit comments

Comments
 (0)