|
| 1 | +# Roadmap |
| 2 | + |
| 3 | +This file captures the longer-term product direction for GitHub Portfolio Reviewer Agent. |
| 4 | + |
| 5 | +It is intentionally vision-oriented rather than time-based. |
| 6 | + |
| 7 | +## Current Foundation |
| 8 | + |
| 9 | +The project already has: |
| 10 | + |
| 11 | +- a hosted Streamlit app |
| 12 | +- deterministic repository scoring |
| 13 | +- per-repository and portfolio-level LLM analysis |
| 14 | +- persistent SQLite-backed caching for single-instance hosting |
| 15 | +- Markdown and PDF export |
| 16 | +- GitHub OAuth for public-profile convenience |
| 17 | +- baseline GitHub Actions CI |
| 18 | + |
| 19 | +## Product Direction |
| 20 | + |
| 21 | +### 1. Stronger Repository Presentation |
| 22 | + |
| 23 | +Keep improving the recruiter-facing polish of the repository and the product: |
| 24 | + |
| 25 | +- refine README screenshots and demo assets as the UI evolves |
| 26 | +- keep exported reports visually stronger and more branded |
| 27 | +- improve documentation around setup, testing, and expected outputs |
| 28 | +- add clearer badges and public signals that make the repo easier to evaluate quickly |
| 29 | + |
| 30 | +### 2. Production-Grade Backend and Hosting Model |
| 31 | + |
| 32 | +The current app is a strong hosted prototype, but the long-term direction is a more explicit application backend: |
| 33 | + |
| 34 | +- move from a Streamlit-only runtime toward a dedicated backend layer where appropriate |
| 35 | +- introduce a FastAPI service for analysis orchestration, background jobs, and cleaner API boundaries |
| 36 | +- support a more standard production deployment model beyond a single hosted Streamlit instance |
| 37 | +- separate frontend presentation concerns from backend execution and persistence concerns |
| 38 | + |
| 39 | +### 3. Shared Persistence Instead of Local SQLite |
| 40 | + |
| 41 | +SQLite works well for local development and single-instance hosting, but the scaling path is a hosted/shared data layer: |
| 42 | + |
| 43 | +- move persistent analysis storage to a hosted database |
| 44 | +- support shared cache/report reuse across instances instead of host-local files only |
| 45 | +- preserve repository freshness validation while making cached reports available across deployments |
| 46 | +- create a cleaner path for usage analytics, audit history, and future team features |
| 47 | + |
| 48 | +Possible future storage direction: |
| 49 | + |
| 50 | +- hosted Postgres or similar managed relational database for persistent report state |
| 51 | +- optional Redis-style cache layer for fast transient reuse and rate-limit protection |
| 52 | + |
| 53 | +### 4. Containerized Deployment and More Portable Infrastructure |
| 54 | + |
| 55 | +For a more production-style deployment model, the app should become easier to run outside the current Streamlit-hosted setup: |
| 56 | + |
| 57 | +- add Docker support for reproducible local and cloud deployment |
| 58 | +- make the runtime environment explicit instead of relying on host defaults |
| 59 | +- support cleaner migration to VPS/cloud/container platforms |
| 60 | +- make browser/PDF dependencies easier to manage consistently across environments |
| 61 | + |
| 62 | +### 5. Repository RAG / Q&A Mode |
| 63 | + |
| 64 | +One of the clearest future product extensions is a public-repo exploration mode: |
| 65 | + |
| 66 | +- allow users to ask questions about a repository after analysis |
| 67 | +- build retrieval over repository structure, README content, and selected source files |
| 68 | +- support repository-level Q&A grounded in indexed public code and docs |
| 69 | +- extend the app from static report generation into interactive repository understanding |
| 70 | + |
| 71 | +This would complement the current audit flow rather than replace it. |
| 72 | + |
| 73 | +### 6. Broader Report Intelligence |
| 74 | + |
| 75 | +Beyond the current recruiter-facing audit, the report system could grow into a richer review layer: |
| 76 | + |
| 77 | +- compare multiple repositories more explicitly |
| 78 | +- cluster portfolio strengths and recurring weaknesses across projects |
| 79 | +- support alternate report modes for recruiters, maintainers, or self-review |
| 80 | +- add stronger export customization for portfolios, case studies, and public showcases |
| 81 | + |
| 82 | +## Guiding Principle |
| 83 | + |
| 84 | +The long-term goal is not just to analyze a GitHub profile once. |
| 85 | + |
| 86 | +It is to turn this project into a more production-grade portfolio intelligence system: |
| 87 | + |
| 88 | +- hosted |
| 89 | +- shareable |
| 90 | +- reproducible |
| 91 | +- scalable |
| 92 | +- and eventually interactive through deeper repository understanding workflows |
0 commit comments