Skip to content

Commit df0e33a

Browse files
authored
Merge pull request #51 from Chaitanya1672/feature/adding-steps-for-rapidapi-integration
added steps for rapidapi or judge0 setup in readme.md
2 parents 2b00f6a + 8dbab3a commit df0e33a

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,33 @@ npm install
2727
yarn install
2828
```
2929

30-
## Setting up Judge0
30+
## Setting Up Judge0 with RapidAPI
3131

32-
Let's set up Judge0 and proceed to the following actions:
32+
1. **Navigate to Judge0**:
33+
- Start by going to the [Judge0 page on RapidAPI](https://rapidapi.com/judge0-official/api/judge0-ce).
34+
- Select the **Basic Plan**, which offers a limit of 50 requests per day.
3335

34-
- Navigate to Judge0, then select the Basic Plan.
35-
- In reality, RapidAPI hosts Judge0. Proceed and sign up for the basic plan.
36-
- You can copy the RAPIDAPI_HOST and RAPIDAPI_KEY, which are required to perform API calls to our code execution system, once you have subscribed.
36+
2. **Sign Up for the Basic Plan**:
37+
- RapidAPI hosts Judge0, so you need to sign up for the Basic Plan on RapidAPI.
38+
- Follow the sign-up process to get started.
39+
40+
3. **Access the RapidAPI Dashboard**:
41+
- After signing up, go to the [RapidAPI Dashboard](https://rapidapi.com/judge0-official/api/judge0-ce).
42+
- In the navigation bar, select **API Hub**.
43+
44+
4. **Navigate to the API's Section**:
45+
- Click on **Endpoints** to view
46+
- You will see multiple endpoints such as Submissions, About, and Languages.
47+
48+
5. **Using the Submissions Endpoint**:
49+
- For code submissions, go to the **Submissions** endpoint and then select **Create Submission**.
50+
- Here, you will find `X-RapidAPI-Key`, `X-RapidAPI-Host`, and the URL (`url`) needed for API calls. Url is located below the "Code Snippets" section.
51+
52+
6. **Copy Required Keys**:
53+
- Copy the `RAPIDAPI_HOST` and `RAPIDAPI_KEY` values. These are necessary to perform API calls to the code execution system.
54+
- Ensure you have these keys saved as they will be used in your API requests.
55+
56+
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.
3757

3858
## Local Configuration
3959

0 commit comments

Comments
 (0)