This project is a React-based code builder that utilizes the Monaco Editor. It allows users to write and execute code snippets within a web browser. It uses Judge0 as a code execution system
Follow these instructions to get the project up and running on your local machine.
Node.js installed on your machine npm or yarn package manager
Clone the repository to your local machine:
git clone <repository-url>
.env
file for successful code submissions
Install dependencies using npm or yarn: bash
npm install
# or
yarn install
To Start project
npm run start
Before starting with the project, ensure you have Docker installed. If not, follow these steps to install Docker:
Windows:
Mac:
Linux:
To start the project using Docker Compose:
Build and run the project:
#Detach mode
docker-compose up -d
docker-compose up
Access the project:
http://localhost:3000
.Close project
docker-compose down
Navigate to Judge0:
Sign Up for the Basic Plan:
Access the RapidAPI Dashboard:
Navigate to the API's Section:
Using the Submissions Endpoint:
X-RapidAPI-Key
, X-RapidAPI-Host
, and the URL (url
) needed for API calls. Url is located below the "Code Snippets" section.Copy Required Keys:
RAPIDAPI_HOST
and RAPIDAPI_KEY
values. These are necessary to perform API calls to the code execution system.By following these steps, you'll be able to set up Judge0 for code submissions using RapidAPI's infrastructure, enabling you to execute and evaluate code within your application.
.env.example
to .env
, you can run below command.
cp .env.example .env
REACT_APP_RAPID_API_HOST=YOUR_HOST_URL
REACT_APP_RAPID_API_KEY=YOUR_SECRET_KEY
REACT_APP_RAPID_API_URL=YOUR_SUBMISSIONS_URL
# key for docker container name
COMPOSE_PROJECT_NAME=custom_code_editor
Replace YOUR_HOST_URL, YOUR_SECRET_KEY, & YOUR_SUBMISSIONS_URL with the appropriate values for your Rapid API and Judge0 API endpoints.
Create a .env file in the root directory of your project if it doesn't already exist. Set the JUDGE0_SUBMISSION_URL environment variable in the .env file. This variable should point to the URL of the Judge0 API endpoint you want to use for code execution. For example: plaintext
JUDGE0_SUBMISSION_URL=https://api.judge0.com/submissions
Replace https://api.judge0.com/submissions with the appropriate URL for your Judge0 API endpoint.
Running the Development Server Once the configuration is complete, you can start the development server to see the React code builder in action.
npm start
# or
yarn start
Open your web browser and navigate to http://localhost:3000 to access the application.
Currently the project url is based out of the free version of judge0 this means at most one can have 50 requests per day.
Contributions are welcome! Feel free to submit pull requests or open issues.
In the cloud-free development environment where you can directly start coding.
You can use Gitpod in the cloud
Feel free to customize this README.md according to your project's specific requirements and features. Let me know if you need further assistance!