Get a complete understanding of how the system works before contributing.
This issue is designed to help you:
- Understand the architecture
- Learn how data flows through the system
- Get clarity on current features and future direction
📌 Step 1: Read the Core Concept
Start here:
- Problem Statement
- Proposed Solution
- Core Philosophy
👉 Focus on this pipeline:
Code → Signals → Insights → Actions → Growth
🧱 Step 2: Understand Architecture
Read the architecture section carefully:
- Frontend: React + Vite + TypeScript
- Backend: Fastify (Node.js)
- DB: Supabase (Postgres)
- Cache: Redis
- GitHub Integration: Octokit
👉 Key Idea:
Frontend NEVER directly depends on GitHub. Everything flows through backend → DB.
🔄 Step 3: Understand Data Flow (Most Important)
Flow:
Frontend
→ Backend (/sync)
→ GitHub API
→ Processing
→ Database
→ Frontend reads from DB
👉 If you don’t understand this, stop and re-read.
🔐 Step 4: Authentication Flow
- GitHub OAuth via Supabase
- No personal tokens
- Session-based access
Understand how:
User → GitHub → Supabase → Session → App
⚙️ Step 5: Explore Features (v1)
- Analytics Dashboard
- Resource Library
- Code Editor (Monaco)
Think:
- What data is needed?
- Where is it stored?
- How is it fetched?
🧠 Step 6: Read Key Design Decisions
Important constraints:
- DB-first rendering
- Aggressive caching
- Backend-controlled GitHub access
🗺️ Step 7: Understand Roadmap
Phase 1
- Analytics
- Resources
- Editor
Phase 2
- Org intelligence
- Learning paths
- Webhooks
Phase 3
✅ Expected Outcome
After completing this issue, you should be able to:
- Explain the full data flow
- Identify where to implement a feature (frontend vs backend vs DB)
- Understand how GitHub data is handled
- Navigate the codebase confidently
📝 Optional Task (Recommended)
Write a short summary (5–10 lines):
- How the system works
- What part interests you most
- What you want to build
📎 Reference
Full system doc
🚀 Next Step
Once done, pick a good-first issue or propose a feature aligned with Phase 1.
Objective Contributing.md
Get a complete understanding of how the system works before contributing.
This issue is designed to help you:
📌 Step 1: Read the Core Concept
Start here:
👉 Focus on this pipeline:
Code → Signals → Insights → Actions → Growth
🧱 Step 2: Understand Architecture
Read the architecture section carefully:
👉 Key Idea:
Frontend NEVER directly depends on GitHub. Everything flows through backend → DB.
🔄 Step 3: Understand Data Flow (Most Important)
Flow:
Frontend
→ Backend (/sync)
→ GitHub API
→ Processing
→ Database
→ Frontend reads from DB
👉 If you don’t understand this, stop and re-read.
🔐 Step 4: Authentication Flow
Understand how:
User → GitHub → Supabase → Session → App
⚙️ Step 5: Explore Features (v1)
Think:
🧠 Step 6: Read Key Design Decisions
Important constraints:
🗺️ Step 7: Understand Roadmap
Phase 1
Phase 2
Phase 3
✅ Expected Outcome
After completing this issue, you should be able to:
📝 Optional Task (Recommended)
Write a short summary (5–10 lines):
📎 Reference
Full system doc
🚀 Next Step
Once done, pick a good-first issue or propose a feature aligned with Phase 1.