Skip to content

Commit 26f141c

Browse files
committed
document judge0 setup
1 parent d2098b1 commit 26f141c

File tree

4 files changed

+47
-1
lines changed

4 files changed

+47
-1
lines changed

README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,53 @@ Now that you have generated your OpenAI API key, you'll need to configure it in
283283

284284
By setting the `OPENAI_API_KEY` environment variable, your application will have the necessary credentials to authenticate and interact with the OpenAI API. This API key allows your application to access OpenAI's language models and services securely.
285285

286-
### 8. Run The Project Locally
286+
---
287+
288+
### 8. Create a RapidAPI Account
289+
290+
To use Judge0 RapidAPI, you'll need to create a RapidAPI account:
291+
292+
#### 8.1. Register for RapidAPI
293+
294+
1. Go to [RapidAPI](https://rapidapi.com/hub).
295+
1. Click "Sign Up" to create your RapidAPI account.
296+
![rapid api](static/jrapid-api.png)
297+
298+
#### 8.2. Search for Judge0 CE
299+
300+
1. In the marketplace, search for "Judge0 CE."
301+
![judge0 api](static/judge0.png)
302+
303+
#### 8.3. Subscribe to the API
304+
305+
1. Click "Subscribe to Test".
306+
1. Choose a plan.
307+
![judge0 api](static/judge0-api.png)
308+
309+
After subscribing, you'll receive an API key for Judge0 RapidAPI.
310+
311+
#### 8.4. Configure Your Judge0 RAPIDAPI API Key
312+
313+
Now that you've obtained your Judge0 RapidAPI API key, it's time to configure it in your project:
314+
315+
1. **Access Your Project Configuration:** Open the configuration file of your project, the `.env` file.
316+
317+
2. **Set the RAPIDAPI Key:** Inside your configuration file, set the following environment variable, replacing `<Your_Judge0_API_Key>` with the actual API key you received from Judge0 RapidAPI:
318+
319+
```yaml
320+
# Judge0 RapidAPI
321+
RAPIDAPI_KEY=<Your_Judge0_API_Key>
322+
```
323+
324+
- Make sure to save the changes to your configuration file.
325+
326+
By setting the `RAPIDAPI_KEY` environment variable, your application will be properly configured to authenticate and communicate with the Judge0 RapidAPI securely. This API key grants access to Judge0's code execution and evaluation capabilities.
327+
328+
For more details, refer to the [official documentation](https://rapidapi.com/judge0-official/api/judge0-ce).
329+
330+
---
331+
332+
### 9. Run The Project Locally
287333

288334
```sh
289335
make run

static/judge0-api.png

157 KB
Loading

static/judge0.png

105 KB
Loading

static/rapid-api.png

314 KB
Loading

0 commit comments

Comments
 (0)