Skip to content

Commit

Permalink
Update name in the project.
Browse files Browse the repository at this point in the history
  • Loading branch information
hermanzdosilovic committed Jun 8, 2020
1 parent 8bb772b commit 74c5229
Show file tree
Hide file tree
Showing 25 changed files with 86 additions and 86 deletions.
4 changes: 2 additions & 2 deletions LICENSE
Expand Up @@ -631,7 +631,7 @@ to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

Judge0 API is an web API for code compilation and execution.
Judge0 is a robust and scalable open-source online code execution system.
Copyright (C) 2016-2020 Herman Zvonimir Došilović

This program is free software: you can redistribute it and/or modify
Expand All @@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:

Judge0 API Copyright (C) 2016-2020 Herman Zvonimir Došilović
Judge0 Copyright (C) 2016-2020 Herman Zvonimir Došilović
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
Expand Down
8 changes: 4 additions & 4 deletions PRIVACY_POLICY.md
@@ -1,9 +1,9 @@
# Privacy Policy
This document is for those who consume the Judge0 API and not for those who deploy the Judge0 API to their own infrastructure.
This document is for those who consume Judge0 and not for those who deploy Judge0 to their own infrastructure.

If you deploy the Judge0 API to your own infrastructure then you should read about [telemetry](TELEMETRY.md).
If you deploy Judge0 to your own infrastructure then you should read about [telemetry](TELEMETRY.md).

## Collected Data
Judge0 API does **not** store any personal information.
Judge0 does **not** store any personal information.

For every submission Judge0 API stores the data that has been well documented [here](https://api.judge0.com/#submissions-submission).
For every submission Judge0 stores the data that has been well documented [here](https://api.judge0.com/#submissions-submission).
30 changes: 15 additions & 15 deletions README.md
@@ -1,5 +1,5 @@
# Judge0 API
[![Judge0 API Wallpaper](https://github.com/judge0/api/blob/master/.github/wallpaper.png?raw=true)](https://api.judge0.com)
# Judge0
[![Judge0 Wallpaper](https://github.com/judge0/api/blob/master/.github/wallpaper.png?raw=true)](https://api.judge0.com)

[![License](https://img.shields.io/github/license/judge0/api?color=2185d0&style=flat-square)](https://github.com/judge0/api/blob/master/LICENSE)
[![Release](https://img.shields.io/github/v/release/judge0/api?color=2185d0&style=flat-square)](https://github.com/judge0/api/releases)
Expand All @@ -10,11 +10,11 @@
<a href="https://paypal.me/hermanzdosilovic" target="_blank"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" alt="Donate with PayPal" height="43px" /></a>

## About
[**Judge0 API**](https://api.judge0.com) is a robust and scalable open-source online code execution system.
[**Judge0**](https://api.judge0.com) is a robust and scalable open-source online code execution system.

Judge0 API can help you build wide range of applications varying from competitive programming platforms, educational and recruitment platforms, to online code editors and more.
Judge0 can help you build wide range of applications varying from competitive programming platforms, educational and recruitment platforms, to online code editors and more.

To see Judge0 API in action, try [Judge0 IDE](https://ide.judge0.com) - free and open-source code editor that uses Judge0 API for executing the user’s source code.
To see Judge0 in action, try [Judge0 IDE](https://ide.judge0.com) - free and open-source code editor that uses Judge0 for executing the user’s source code.

## Features
- Quick and easy [installation](https://github.com/judge0/api#installation).
Expand All @@ -33,13 +33,13 @@ For more information check out https://api.judge0.com.
Choose a plan on [RapidAPI](https://rapidapi.com/hermanzdosilovic/api/judge0/pricing) or [install](https://github.com/judge0/api#installation) on your own server.

## Installation
To install Judge0 API on your own server follow [deployment procedure](https://github.com/judge0/api/blob/master/CHANGELOG.md#deployment-procedure) for the latest release.
To install Judge0 on your own server follow [deployment procedure](https://github.com/judge0/api/blob/master/CHANGELOG.md#deployment-procedure) for the latest release.

## Demo
[![asciicast](https://asciinema.org/a/318465.svg)](https://asciinema.org/a/318465)

## References
These companies, organizations and projects successfully use Judge0 API in production:
These companies, organizations and projects successfully use Judge0 in production:
- [Adzetech](https://adzetech.com)
- [AlgoLadder](http://algoladder.com)
- [Ask To How](https://www.asktohow.com)
Expand All @@ -63,7 +63,7 @@ These companies, organizations and projects successfully use Judge0 API in produ
- [Indian Institute of Technology Mandi](http://www.iitmandi.ac.in)
- [Instacks](https://instacks.in)
- [Institute of Aeronautical Engineering](https://www.iare.ac.in)
- [JavaJudge0Api](https://github.com/bloodnighttw/JavaJudge0Api) - a Java library for interacting with the Judge0 API
- [JavaJudge0Api](https://github.com/bloodnighttw/JavaJudge0Api) - a Java library for interacting with Judge0
- [Judge Code Online](http://en.chamcode.net)
- [KPR Institute of Engineering and Technology](https://www.kpriet.ac.in)
- [KodKarate](http://www.kodkarate.in) - an open-source IDE
Expand All @@ -81,9 +81,9 @@ These companies, organizations and projects successfully use Judge0 API in produ
- [University of Zagreb, Faculty of Electrical Engineering and Computing](https://www.fer.unizg.hr/en)
- [VS Code App](https://apps.apple.com/US/app/id1512938504) - lightweight universal IDE for iOS / iPadOS with full iCloud Drive support
- [Xiith](https://xiith.com)
- [judge0-gem](https://github.com/TopRoupi/judge0-gem) - Ruby Gem for interacting with the Judge0 API
- [judge0_helm](https://github.com/saikatharryc/judge0_helm) - Helm Chart for Judge0 API
- [judge0api](https://github.com/vCra/judge0api) - Python library for interacting with Judge0 API
- [judge0-gem](https://github.com/TopRoupi/judge0-gem) - Ruby Gem for interacting with Judge0
- [judge0_helm](https://github.com/saikatharryc/judge0_helm) - Helm Chart for Judge0
- [judge0api](https://github.com/vCra/judge0api) - Python library for interacting with Judge0
- [nGrader](https://ngrader.herokuapp.com)
- [primat.org](http://primat.org)
- [uDebug Tool](https://www.udebugtool.com)
Expand All @@ -93,7 +93,7 @@ These companies, organizations and projects successfully use Judge0 API in produ
Feel free to add yours to the list by sending me an [email](mailto:hermanz.dosilovic@gmail.com) or creating an [issue](https://github.com/judge0/api/issues/new).

## Research Paper
We wrote a research paper about Judge0 API that you can find [here](https://minio.judge0.com/public/paper-in-review.pdf).
We wrote a research paper about Judge0 that you can find [here](https://minio.judge0.com/public/paper-in-review.pdf).

## Community
Do you have a question, feature request or something else on your mind?
Expand All @@ -109,15 +109,15 @@ Check out these links:
* [Schedule an online meeting with the author](https://judge0.appointlet.com)

## Author and Contributors
Judge0 API was created by [Herman Zvonimir Došilović](https://github.com/hermanzdosilovic).
Judge0 was created by [Herman Zvonimir Došilović](https://github.com/hermanzdosilovic).

Thanks a lot to all [contributors](https://github.com/judge0/api/graphs/contributors) for their contributions in this project.

## Changelog
Detailed specification of changes between versions can be found in [CHANGELOG.md](https://github.com/judge0/api/blob/master/CHANGELOG.md).

## Special Thanks
Special thanks to these open-source projects without whom Judge0 API probably wouldn't exist: [isolate](https://github.com/ioi/isolate), [Docker](https://github.com/docker), [Ruby on Rails](https://github.com/rails/rails) and others.
Special thanks to these open-source projects without whom Judge0 probably wouldn't exist: [isolate](https://github.com/ioi/isolate), [Docker](https://github.com/docker), [Ruby on Rails](https://github.com/rails/rails) and others.

## Supporters
Thanks a lot to all my [Patrons](https://www.patreon.com/hermanzdosilovic) and [PayPal](https://paypal.me/hermanzdosilovic) donors that supported Judge0 development. Thank you! ♥
Expand All @@ -126,4 +126,4 @@ Thanks a lot to all my [Patrons](https://www.patreon.com/hermanzdosilovic) and [
Your are more than welcome to support Judge0 development on [Patreon](https://www.patreon.com/hermanzdosilovic), via [PayPal](https://paypal.me/hermanzdosilovic) or [Revolut](https://pay.revolut.com/profile/hermancy5).

## License
Judge0 API is licensed under the [GNU General Public License v3.0](https://github.com/judge0/api/blob/master/LICENSE).
Judge0 is licensed under the [GNU General Public License v3.0](https://github.com/judge0/api/blob/master/LICENSE).
12 changes: 6 additions & 6 deletions TELEMETRY.md
@@ -1,10 +1,10 @@
# Telemetry
This document is for those who deploy the Judge0 API to their own infrastructure and not for those who consume the Judge0 API.
This document is for those who deploy Judge0 to their own infrastructure and not for those who consume Judge0.

If you just consume the Judge0 API then you should read the [privacy policy](PRIVACY_POLICY.md).
If you just consume Judge0 then you should read the [privacy policy](PRIVACY_POLICY.md).

## Introduction
Since version v1.6.0 Judge0 API is collecting telemetry data which is used to help understand how to improve the product and to better understand how the Judge0 API is used in various production environments.
Since version v1.6.0 Judge0 is collecting telemetry data which is used to help understand how to improve the product and to better understand how Judge0 is used in various production environments.

Our close-source [telemetry client](bin/telemetry) periodically sends telemetry data to our central telemetry server.

Expand All @@ -16,12 +16,12 @@ This document describes how to disable telemetry reporting and what data is coll
To disable telemetry reporting set variable `JUDGE0_TELEMETRY_ENABLE` to `false` in [judge0-api.conf](judge0-api.conf).

## Collected Data
Every deployed instance of the Judge0 API with enabled telemetry reporting has its own ID that is used to identify the instance.
Every deployed instance of Judge0 with enabled telemetry reporting has its own ID that is used to identify the instance.

### The Data Telemetry Client Sends
Your instance of the Judge0 API will send the new telemetry report to our central telemetry server every 12 hours. Following data is send in the report:
Your instance of Judge0 will send the new telemetry report to our central telemetry server every 12 hours. Following data is send in the report:
- the ID of your instance and
- the version of your Judge0 API instance
- the version of your Judge0 instance

### The Data Telemetry Server Stores
When the new telemetry report arrives our telemetry server stores the following data:
Expand Down
8 changes: 4 additions & 4 deletions docs/api/authentication/authentication.md
@@ -1,6 +1,6 @@
# Group Authentication
Administrators of Judge0 API can configure Judge0 API to require you to have an authentication token (a.k.a. API key).
If that is the case with the instance of Judge0 API you are using, then you
Administrators of Judge0 can configure Judge0 to require you to have an authentication token (a.k.a. API key).
If that is the case with the instance of Judge0 you are using, then you
should provide `X-Auth-Token` header field in **every** API request.

## Authenticate [/authenticate]
Expand All @@ -9,9 +9,9 @@ Check if your authentication token is valid.

::: note
<h4>Note</h4>
* `X-Auth-Token` is default header field name, but administrators of Judge0 API instance you are using
* `X-Auth-Token` is default header field name, but administrators of Judge0 instance you are using
can change this default field name.
* Contact administrator of Judge0 API instance you are using to get your authentication token.
* Contact administrator of Judge0 instance you are using to get your authentication token.
:::

::: warning
Expand Down
6 changes: 3 additions & 3 deletions docs/api/authorization/authorization.md
@@ -1,6 +1,6 @@
# Group Authorization
To issue some API calls you need to be authorized. For example, you need to be authorized to
[list all submissions](#submissions-submission-get-1) on Judge0 API.
[list all submissions](#submissions-submission-get-1) on Judge0.

## Authorize [/authorize{?X-Auth-User}]
### Authorize [POST]
Expand All @@ -9,9 +9,9 @@ authenticate in this API call.

::: note
<h4>Note</h4>
* `X-Auth-User` is default header field name, but administrators of Judge0 API instance you are using
* `X-Auth-User` is default header field name, but administrators of Judge0 instance you are using
can change this default field name.
* Contact administrator of Judge0 API instance you are using to get your authorization token.
* Contact administrator of Judge0 instance you are using to get your authorization token.
:::

::: warning
Expand Down
12 changes: 6 additions & 6 deletions docs/api/docs.md
@@ -1,14 +1,14 @@
FORMAT: 1A
HOST: https://api.judge0.com

# Judge0 API
# Judge0 - API Documentation
<!-- include(hostname.html) -->
<!-- include(style.html) -->

## About
[Judge0 API](https://api.judge0.com) is a robust and scalable [open-source](https://github.com/judge0/api) online code execution system. It can be used to build a wide range of applications varying from competitive programming platforms, educational and recruitment platforms, to online code editors, and more.
[Judge0](https://api.judge0.com) is a robust and scalable [open-source](https://github.com/judge0/api) online code execution system. It can be used to build a wide range of applications varying from competitive programming platforms, educational and recruitment platforms, to online code editors, and more.

To see Judge0 API in action, try [Judge0 IDE](https://ide.judge0.com) - a free and [open-source](https://github.com/judge0/ide) online code editor that uses Judge0 API for executing the user’s source code. You can also try using a [dummy client](/dummy-client.html) which can help you explore and test most of the features of the Judge0 API.
To see Judge0 in action, try [Judge0 IDE](https://ide.judge0.com) - a free and [open-source](https://github.com/judge0/ide) online code editor that uses Judge0 for executing the user’s source code. You can also try using a [dummy client](/dummy-client.html) which can help you explore and test most of the features of Judge0.

## Features
- Quick and easy [installation](https://github.com/judge0/api#installation).
Expand All @@ -25,18 +25,18 @@ To see Judge0 API in action, try [Judge0 IDE](https://ide.judge0.com) - a free a
Choose a plan on [RapidAPI](https://rapidapi.com/hermanzdosilovic/api/judge0/pricing) or [install](https://github.com/judge0/api#installation) on your own server.

## Research Paper
You can read a research paper about Judge0 API [here](https://minio.judge0.com/public/paper-in-review.pdf).
You can read a research paper about Judge0 [here](https://minio.judge0.com/public/paper-in-review.pdf).

## Version
This document describes Judge0 API [v1.9.0](https://github.com/judge0/api/tree/v1.9.0).
This document describes Judge0 [v1.9.0](https://github.com/judge0/api/tree/v1.9.0).

## Date and time formats
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard is used.

Example: `2016-09-11T10:19:35Z`

## License
Judge0 API is licensed under the [GNU General Public License v3.0](https://github.com/judge0/api/blob/master/LICENSE).
Judge0 is licensed under the [GNU General Public License v3.0](https://github.com/judge0/api/blob/master/LICENSE).

## Donate
Your are more than welcome to support Judge0 development on [Patreon](https://www.patreon.com/hermanzdosilovic), via [PayPal](https://paypal.me/hermanzdosilovic) or [Revolut](https://pay.revolut.com/profile/hermancy5).
Expand Down
6 changes: 3 additions & 3 deletions docs/api/submissions/create_a_submission.md
Expand Up @@ -6,19 +6,19 @@ If submission's `source_code`, `stdin` or `expected_output` contains non printab
characters which cannot be sent with JSON, then set `base64_encoded` parameter to `true` and
send these attributes Base64 encoded. Your responsibility is to encode each of mentioned attributes
(`source_code`, `stdin` and `expected_output`) even if just one of them contains non printable
characters. By default, this parameter is set to `false` and Judge0 API assumes you are sending plain text data.
characters. By default, this parameter is set to `false` and Judge0 assumes you are sending plain text data.

By default you are returned submission token on successful submission creation. With this token you can [check submission status](#submission-submission-get).
Instead of checking submission status by making another request, you can set the `wait` query parameter to `true` which will enable you to get submission status immediately as part of response to the request you made.
Please note that this feature may or may not be enabled on all Judge0 API hosts. So before using this feature please check [configuration](#system-and-configuration-configuration-info-get) of Judge0 API you are using. On an [official Judge0 API](https://api.judge0.com) this feature **is not** enabled.
Please note that this feature may or may not be enabled on all Judge0 hosts. So before using this feature please check [configuration](#system-and-configuration-configuration-info-get) of Judge0 you are using. On an [official Judge0](https://api.judge0.com) this feature **is not** enabled.

::: note
<h4>Note</h4>
* We **do not** recommend the use of `wait=true` feature because it does not scale well.
:::

+ Parameters
+ base64_encoded = `false` (optional, boolean, `false`) ... Set to `true` if you want to send Base64 encoded data to Judge0 API.
+ base64_encoded = `false` (optional, boolean, `false`) ... Set to `true` if you want to send Base64 encoded data to Judge0.
+ wait = `false` (optional, boolean, `false`) ... Set to `true` to immediately get submission result.

+ Request (application/json)
Expand Down
4 changes: 2 additions & 2 deletions docs/api/submissions/delete_a_submission.md
Expand Up @@ -2,8 +2,8 @@
Delete specific submission.

You need to be authorized to issue this request. Although you are
authorized you might not be able to delete submission because administrator of Judge0 API instance
you are using disallowed submission deletion. So before using this feature please check [configuration](#system-and-configuration-configuration-info-get) of Judge0 API you are using.
authorized you might not be able to delete submission because administrator of Judge0 instance
you are using disallowed submission deletion. So before using this feature please check [configuration](#system-and-configuration-configuration-info-get) of Judge0 you are using.

For this request query parameter `base64_encoded` is implicitly set to `true` and cannot be changed.
This guarantees you will successfully get requested submission attributes after deletion.
Expand Down

0 comments on commit 74c5229

Please sign in to comment.