this blog post (1 min read) before continuing.[NEWS] Please read
Judge0 API is an web API for code compilation and execution. Complete and detailed API documentation is available on https://api.judge0.com.
- Supported Languages
- Project Organization
- Quick Development Setup
- Quick Production Setup
- About Docker Images
- Adding New Compiler or Interpreter
- HTTPS In Production
|3||Basic (fbc 1.05.0)|
|4||C (gcc 7.2.0)|
|5||C (gcc 6.4.0)|
|6||C (gcc 6.3.0)|
|7||C (gcc 5.4.0)|
|8||C (gcc 4.9.4)|
|9||C (gcc 4.8.5)|
|10||C++ (g++ 7.2.0)|
|11||C++ (g++ 6.4.0)|
|12||C++ (g++ 6.3.0)|
|13||C++ (g++ 5.4.0)|
|14||C++ (g++ 4.9.4)|
|15||C++ (g++ 4.8.5)|
|16||C# (mono 18.104.22.168)|
|17||C# (mono 22.214.171.124)|
|21||Erlang (OTP 20.0)|
|23||Haskell (ghc 8.2.1)|
|24||Haskell (ghc 8.0.2)|
|26||Java (OpenJDK 9 with Eclipse OpenJ9)|
|27||Java (OpenJDK 8)|
|28||Java (OpenJDK 7)|
|33||Pascal (fpc 3.0.0)|
|43||Text (plain text)|
Judge0 API is a Rails 5 application organized in two major components:
- Rails API
- accepts requests and creates background jobs for Worker.
- accepts new jobs and process them as they arrive. Worker has only one job - IsolateJob, that job runs untrusted programs in sandboxed environment.
Quick Development Setup
Because we are running our development environment in Docker you don't need to have Ruby, Rails, PostgreSQL, Redis, etc. installed on your computer. You just need to:
- Pull judge0/api image:
$ docker pull judge0/api
- Run development shell (it will take a while only first time):
- Create, migrate and seed the database:
$ rails db:setup
scripts/dev-shell script will open you new development shell always in the same container, and if container doesn't exist it will create one for you.
You need to run Rails API and Worker in order to have Judge0 API fully operational:
- Open new development shell and in there run Rails API server:
- Open new development shell again and in there run Worker process:
- Open http://localhost:3000 in your browser.
This is minimal setup for development environment, now you can open your favorite editor in your host and start developing Judge0 API.
Quick Production Setup
Copy docker-compose.prod.yml on your server and save it as
$ wget https://raw.githubusercontent.com/judge0/api/master/docker-compose.prod.yml -O docker-compose.yml
Save judge0-api.conf.default to your server as
$ wget https://raw.githubusercontent.com/judge0/api/master/judge0-api.conf.default -O judge0-api.conf
$ docker-compose up -d db
Run all other services:
$ docker-compose up -d
http://<IP OF YOUR SERVER>:3000in your browser.
About Docker Images
This project has two Dockerfiles:
judge0/api:latest is built FROM
judge0/api-base:latest image which contains installed compilers and sandbox environment. This image represents production image of Judge0 API.
judge0/api:dev is your local development image built FROM
judge0/api:latest. It is not pushed to Docker Hub. That is why you first need to pull
judge0/api:latest before building your development environment.
Adding New Compiler or Interpreter
To add new compiler or interpreter you first need to install it into Judge0 API Base image. Instructions on how to do that can be found in documentation for Judge0 API Base.
After you have added your favorite compiler/interpreter to Judge0 API Base image you need to define how this compiler/interpreter is used. This is done in
You have four attributes:
name- name of your language you are supporting, include also compiler name and version
source_file- in what file should user's source code be saved before it is compiled
compile_cmd- how this file is compiled, interpreted languages won't have this attribute
run_cmd- how should we run this compiled or interpreted language
We already provided enough examples for most common languages, be sure to check that out.
HTTPS In Production
To use HTTPS in production we are going to use https://letsencrypt.org/.
Everything else you need to do is described in Quick Production Setup section.
Judge0 API is simple to use and develop only if you are comfortable with using Docker and Docker Compose.
Docker and Docker Compose allow us to get rid of all dependencies, and concentrate on what is important - features, functionality and reliability.
Please before working with Judge0 API project, make yourself comfortable with Docker and Docker Compose, because we are using it extensively.
We will add extensive documentation in the future about how and why we are using Docker and Docker Compose here, but this documentation won't substitute your knowledge of this technologies.
Feel free to ask us any questions in Issues directly. :)
If you like Judge0, please consider making a donation to support this project.