Skip to content

Home

Jump to bottom
Aviral Joshi edited this page Sep 30, 2025 · 1 revision

Welcome to the AlgoRise wiki!

# AlgoRise — Wiki

![GitHub Repo stars](https://img.shields.io/github/stars/Hackeries/AlgoRise?style=social)
![GitHub issues](https://img.shields.io/github/issues/Hackeries/AlgoRise)
![GitHub license](https://img.shields.io/github/license/Hackeries/AlgoRise)

---

## 🚀 Overview

**AlgoRise** is a real-time companion for competitive programming.  
It helps users track Codeforces ratings, streaks, solved problems, get personalized recommendations, participate in contests, and view live leaderboards.

[🔗 GitHub Repo](https://github.com/Hackeries/AlgoRise)

---

## 📋 Table of Contents

- [Features](#features)  
- [Architecture & Tech Stack](#architecture--tech-stack)  
- [Setup & Installation](#setup--installation)  
- [Usage](#usage)  
- [Database & Schema](#database--schema)  
- [Deployment](#deployment)  
- [Contributing](#contributing)  
- [Roadmap / Future Work](#roadmap--future-work)  
- [Credits & License](#credits--license)  
- [FAQ](#faq)  

---

## Features

<details>
<summary>Click to expand Features</summary>

- **Codeforces Integration** — OAuth, sync rating changes, solved problems  
- **Personalized Recommendations** — problems tailored to user performance  
- **Progress Analytics** — track performance over time, streaks, strengths & weaknesses  
- **Streak Tracking** — encourage daily problem solving  
- **Group / College Contests** — host or join contests  
- **Live Leaderboards** — real-time rankings  
- **Complete Documentation** — setup guides, deployment checklists, database guides  

</details>

---

## Architecture & Tech Stack

<details>
<summary>Click to expand Architecture & Tech Stack</summary>

| Layer / Component | Technology / Tools |
|------------------|------------------|
| Frontend / UI    | Next.js (React) |
| Styling          | Tailwind CSS |
| Backend / API    | Next.js serverless / API routes |
| Database         | Supabase (PostgreSQL) |
| Authentication   | Supabase Auth + OAuth |
| Deployment       | Vercel / Netlify / AWS |
| Others           | TypeScript, middleware, scripts |

</details>

---

## Setup & Installation

<details>
<summary>Click to expand Setup & Installation</summary>

1. **Clone the repository**  
```bash
git clone https://github.com/Hackeries/AlgoRise.git
cd AlgoRise
  1. Install dependencies
npm install
  1. Database setup
  • Use Supabase dashboard → SQL Editor
  • Run SUPABASE_SETUP.sql
  • Optional scripts: CONTEST_DATABASE_SETUP.sql, ENHANCED_CONTEST_SCHEMA.sql
  1. Environment variables
  • Configure .env.local with Supabase URL, keys, OAuth secrets
  1. Run in development
npm run dev
  1. Build & production run
npm run build
npm start

Usage

Click to expand Usage
  • Link your Codeforces account
  • View analytics, dashboards, and leaderboards
  • Host or join group contests
  • Track problem-solving streaks
  • Access personalized problem recommendations

(Add screenshots/GIFs for clarity)

Database & Schema

Click to expand Database & Schema
  • Key tables: users, problems, contests, submissions, ratings
  • Relationships: one-to-many, many-to-many
  • Important SQL scripts:

  * CONTEST_DATABASE_SETUP.sql   * ENHANCED_CONTEST_SCHEMA.sql

  • Optional: ER diagram for visualization

Deployment

Click to expand Deployment
  • Hosting: Vercel / Netlify / AWS
  • Set environment variables for production
  • Run migrations and seed initial data
  • Monitor database, performance, and backups

Contributing

Click to expand Contributing
  • Fork → branch → PR → review workflow
  • Follow coding guidelines, linting, formatting
  • Run tests (if any) before submitting PRs
  • Core maintainers / contacts can be listed here

Roadmap / Future Work

Click to expand Roadmap
  • Support more CP platforms (CodeChef, AtCoder)
  • Advanced recommendation algorithms
  • Social features & discussion forums
  • Mobile apps / PWA support
  • Gamification: badges, achievements
  • Performance optimization & scaling

Credits & License

Click to expand Credits & License
  • Contributors / maintainers: See repo contributors
  • Libraries or tools used
  • License: MIT (GitHub)

FAQ

Click to expand FAQ

Q: What happens if Codeforces API is down? A: Sync will resume once API is available.

Q: Can I unlink my account? A: Yes, via profile settings.

Q: How is performance on large user base? A: Optimized for real-time updates with Supabase.

Q: How to migrate existing data? A: Follow database migration scripts.

```

Clone this wiki locally