Raccoon Mascot

Developer Documentation

Everything you need to contribute to func(Kode) and build together with our community

šŸš€ Quick Start

For New Contributors

Get started with your own development environment in minutes.

šŸ“– Setup Guide

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!