Skip to content

Latest commit

 

History

History
314 lines (235 loc) · 7.82 KB

README.md

File metadata and controls

314 lines (235 loc) · 7.82 KB
Raw

CodePad

A state-of-the-art Competitive Programming platform.
See you on the Leaderboard!

View CodePad · Raise Issue · Support

Table of Contents

🔎 About the Project

CodePad is the Competitive Programming platform of JSSATEN. This platform is way cooler than a normal coding website because of it's Retro VCR Design, Integrated Coding Editor for 45+ languages, Programming Contests, and their Live Leader-boards.

At CodePad, The Nibble Computer Society conducts multiple Programming Competitions to revive the geek in you, and keep promoting the coding culture in our college.

So, charge all your laptops and Happy Coding!

Built With React and Django.

🎯 Features

  • Interesting UI/UX to not get bored easily
  • Host multiple Contests
    • Custom time duration of Contest
    • Multiple Problems per Contest
      • Multiple testcases per Problems
      • Custom Score of easy Problem
      • Custom Penalty on wrong solution submission
      • Score deduction with time gradient
    • Live Leaderboard
  • Integrated Code Editor to code side-by-side
    • Upload your code file directly to the editor
    • Syntax Highlighting and Auto-Completion
    • Statistics of the code execution
      • Time in seconds and Memory in KiloBytes
      • stdout and stderr
    • Custom input to pass as stdin
  • 45+ Programming Languages supported
  • Optimized evaluation to prevent bottlenecks
    • Asynchronous Evaluation of submissions
    • Load balanced workers to execute and evaluate code

⚡️ Quick Start

Prerequisites

The following things must be ready for function of the project:

The first thing to do is to clone the repository:

git clone https://github.com/SingingApple/Code-Pad.git
cd Code-Pad
⚙️ Backend

In the current directory:

  1. create a .env file to store environment variables
touch .env
  1. Set the following environment variables in the .env file
.env 
# General Settings

SERVER_HOST="*"
DJANGO_SECRET_KEY=""
DEBUG=True
FRONTEND_HOST="localhost:3000"


# Static Settings

# If you are using Cloudinary as a CDN, set these three variables. Else leave them commented
# MEDIA_CLOUD_NAME=
# MEDIA_API_KEY=
# MEDIA_API_SECRET=

# If Cloudinary env vars are not provided then these two are used automatically
MEDIA_ROOT="media/"
STATIC_ROOT="static/"


# Email Settings

# Emailing stuff will not work without these environment variables. Rest will work, if you leave them empty.
EMAIL_USE_TLS= # True/False
EMAIL_HOST=""
EMAIL_PORT=587
EMAIL_HOST_USER=""
EMAIL_HOST_PASSWORD=""

# Set the same as EMAIL_HOST_USER
DEFAULT_FROM_EMAIL=""


# Postgres Settings

# Set these five variables if you want to use PostgreSQL.
# Otherwise leave them commented to use SQLite by default.
# POSTGRES_DB=""
# POSTGRES_USER=""
# POSTGRES_PASSWORD=""
# POSTGRES_HOST=""
# POSTGRES_PORT=""


# Judge Settings

JUDGE_HOST="http://judge0IsHostedHere/"
X_Auth_Token=""
FILE_SIZE_LIMIT_KB="512"


# RabbitMQ Settings

RABBITMQ_DEFAULT_VHOST=""
RABBITMQ_DEFAULT_USER=""
RABBITMQ_DEFAULT_PASS=""
RABBITMQ_DEFAULT_HOST=""
  1. Create a virtual environment to install dependencies in and activate it:
virtualenv venv
source venv/bin/activate
  1. Then install the dependencies:
pip install -r requirements.txt
  1. Migrate using
python manage.py migrate
  1. Finally Run the developement server using
python manage.py runserver

Note -

If you have configured your own Judge0 and RabbitMQ server then you may also need to run a celery worker to process the messages. For that:

  1. Export the RabbitMQ broker URL in environment
export RABBITMQ_BROKER=""
  1. Run the celery workers using
celery worker --app CodePad --loglevel info --queue submissions --broker $RABBITMQ_BROKER

That's all you need to know for the backend! 🎉

🖼️ Frontend

In the client directory:

  1. Create a .env file to store environment variables
touch .env
  1. Set the following environment variables in the .env file
.env 
REACT_APP_BASEURL="http://localhost:8000"
HTTP_PROXY="http://localhost:8000"
REACT_APP_JUDGEHOST="https://judge0IsHostedHere/submissions/?wait=true&base64_encoded=true"
REACT_APP_JUDGELANGUAGE="https://judge0IsHostedHere/languages"

Now you can use:

yarn

Installs all the dependencies.

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

That's all you need to know for the frontend! 🎉

🐳 Docker-way to quick start the complete project

In the root directory:

  1. Change the following value in the .env file.
.env 
# Postgres Settings

POSTGRES_DB="codepad"
POSTGRES_USER="hackNCS"
POSTGRES_PASSWORD="CodePadDatabaseHackNCS"
POSTGRES_HOST="postgres"
POSTGRES_PORT="5432"


# RabbitMQ Settings

RABBITMQ_DEFAULT_VHOST="codepad"
RABBITMQ_DEFAULT_USER="hackNCS"
RABBITMQ_DEFAULT_PASS="CodePadRabbitMQHackNCS"
RABBITMQ_DEFAULT_HOST="rabbitmq"

Note: Rest of the variables shall be same as defined under Backend category above.

  1. Set the variable in the client/.env file same as above in the frontend category.

  2. Make sure there is no service running on the following ports already.

    • 3000 - for React app
    • 8000 - for Django server
    • 5672 - for RabbitMQ server
    • 15672 - for RabbitMQ admin
    • 5432 - for PostgreSQL server
lsof -i -P -n | grep 127.0.0.1:<port_number>

If there are some services running then terminate them using their respective closing commands.

  1. Create a docker network which might come useful to connect the django server to the judge0.
docker network create codenet
  1. Finally, in the root directory, Spin-Up the project using
docker-compose up

Contributors

📝 License

This project follows the MIT License.