
Developer Documentation
Everything you need to contribute to func(Kode) and build together with our community
š Quick Start
OAuth Architecture
Understand our secure dual OAuth setup for production and development.
š Security Docsš ļø Tech Stack
āļø
Next.js 15
App Router, Server Components, TypeScript
šØ
Tailwind CSS
Utility-first CSS framework
šļø
Supabase
Auth, Database, Real-time
š
GitHub
OAuth, Webhooks, API
š Project Structure
funcKode/site/ āāā app/ # Next.js App Router ā āāā (auth)/ # Authentication routes ā āāā dashboard/ # User dashboard ā āāā api/ # API routes ā āāā globals.css # Global styles āāā components/ # Reusable UI components ā āāā ui/ # Base UI components ā āāā tutorial/ # Tutorial components āāā lib/ # Utility libraries ā āāā supabase/ # Supabase client & utilities āāā docs/ # Documentation files āāā database/ # Database schema āāā public/ # Static assets
š Development Workflow
1. Fork & Clone
git clone https://github.com/YOUR_USERNAME/site.git
2. Set Up Environment
Create your own:
- ⢠GitHub OAuth App
- ⢠Supabase Project
- ⢠Environment Variables
3. Develop & Test
npm install && npm run dev
Test locally on localhost:3000
4. Submit PR
Create pull request to dev branch
š” API Reference
GitHub Webhooks
/api/github/webhook
Handles GitHub events for activity tracking
Activity Feed
/api/activity-feed
Real-time organization activity data
Projects API
/api/projects
CRUD operations for projects
Auth Callback
/auth/callback
OAuth callback handler
š¤ Contributing Guidelines
Code Standards
- āTypeScript for type safety
- āESLint for code quality
- āPrettier for formatting
- āMeaningful commit messages
PR Guidelines
- āCreate feature branch from dev
- āTest your changes locally
- āUpdate documentation if needed
- āLink related issues
š Resources & Links
Ready to Build Together?
Join our community of developers and start contributing to open-source projects today!