Home

📚 MiniCode Wiki

Welcome to the official MiniCode Wiki — a complete documentation hub for understanding, using, developing, and deploying the MiniCode platform.

MiniCode is a full-stack coding ecosystem that integrates GitHub workflows, AI-powered evaluation, gamification, and academic management tools into a single platform.

🧭 Table of Contents

Overview
System Architecture
Core Concepts
User Roles & Workflows
Submission & AI Judge Pipeline
Deployment Guide
Backend Developer Guide
Design & UX Vision
Troubleshooting
Future Scope

📌 1. Overview

MiniCode is designed for:

🎓 Colleges and universities
💻 Coding clubs
🏆 Hackathons and competitions

It enables:

Real GitHub-based coding
AI-assisted evaluation (Gemini)
Role-based access control
Events, leaderboards, and XP systems

Unlike traditional platforms, MiniCode focuses on real-world development workflows instead of isolated code editors.

🏗️ 2. System Architecture

Frontend (Next.js)
   ↓
Backend API (FastAPI)
   ↓
Redis (Cache + Queue)
   ↓
Database (PostgreSQL / SQLite)
   ↓
Celery Workers (Async Processing)
   ↓
External APIs (GitHub, Google OAuth, Gemini AI)

🧩 3. Core Concepts

GitHub-Based Coding

Each problem creates a private repository
Students write and commit code locally
Submission uses commit history as context

AI-Based Judging

Uses Gemini API
Evaluates:
- Correctness
- Code quality
- AI probability
Returns structured feedback

⚠️ Code is NOT executed in a sandbox.

Gamification

XP system
Levels
Leaderboards
Events and rewards

👥 4. User Roles & Workflows

🎓 Student

Login via GitHub
Start problems → repo created
Write code and commit
Submit → AI evaluation
Earn XP and climb leaderboard

👨‍🏫 Faculty

Create problems
Monitor student performance
Award XP
Manage events

🛠️ Admin

Manage users and roles
View system analytics
Maintain platform operations

Detailed workflow reference: fileciteturn1file3

🔄 5. Submission & AI Judge Pipeline

Student starts problem
Repo created via GitHub API
Student commits code
Submission created (pending)
Celery worker processes submission
AI judge analyzes code
Score and feedback stored

Key Notes:

Async processing ensures scalability
AI judging is probabilistic

🚀 6. Deployment Guide

MiniCode supports both free-tier deployment and production-scale hosting.

Free Deployment Stack ($0/month)

Frontend: Vercel
Backend: Render
Database: Supabase
Redis: Upstash
AI: Google Gemini Free Tier

Production Deployment

Scalable backend instances
Dedicated database
Paid AI usage

Full deployment guide: fileciteturn1file1

🧠 7. Backend Developer Guide

Responsibilities

Authentication & authorization
API management
Submission pipeline
Database handling

Key Components

FastAPI backend
SQLModel ORM
Celery workers
Redis caching

Important Files

main.py → API entry point
worker.py → async tasks
judge.py → AI evaluation
auth.py → authentication

Full developer reference: fileciteturn1file4

🎨 8. Design & UX Vision

MiniCode follows a modern SaaS + Gen-Z developer experience philosophy.

Principles

Zero friction navigation
Gamified engagement
Clean, premium UI
AI-assisted feedback instead of harsh errors

Visual Style

Dark theme (glassmorphism + neon accents)
Smooth animations
Dashboard-driven experience

Full design vision: fileciteturn1file2

🛠️ 9. Troubleshooting

Common Issues

Submission stuck

Worker not running
Redis connection failed

OAuth errors

Incorrect callback URL
Invalid client credentials

Repo issues

Problem not started correctly
GitHub auth expired

AI errors

Invalid API key

🔮 10. Future Scope

Code execution sandbox
Advanced plagiarism detection
AI mentorship system
Mobile app support

📌 Conclusion

MiniCode is more than a coding platform — it is a complete development ecosystem that prepares students for real-world engineering workflows.

By combining GitHub, AI, and gamification, it bridges the gap between:

📚 Learning 💻 Development 🏆 Competition

Navigation Menu