README.md

Online Judge (OJ) Platform

Online Judge is a web-based platform designed for programming enthusiasts to practice and improve their coding skills by solving programming challenges.

Table of Contents

• Features
• Prerequisites
• Installation
• Configuration
• Usage
• Folder Structure
• API Documentation
• Contributing
• License

Features

• User authentication and profile management
• Problem-solving interface with syntax highlighting
• Submission and evaluation of code
• Leaderboard for users based on performance
• Admin panel for managing problems and users
• ...

Prerequisites

Make sure you have the following installed on your machine:

• Node.js: Download Node.js
• MongoDB: Download MongoDB

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/oj.git
   

2. Navigate to the project directory

   cd oj
   

3. Start frontend and backend server

   cd client
   npm install
   npm start
   
   cd server
   npm install
   npm start

4. Start Docker container and Redis server for queue

Folder Structure

oj-platform/ |-- client/ # React frontend application |-- server/ # Node.js Express backend server |-- public/ # Static files |-- README.md # Project documentation |-- .env # Environment variables |-- .gitignore # Git ignore file |-- package.json # Server dependencies and scripts |-- client/package.json # Client dependencies and scripts |-- server/package.json # Server dependencies and scripts