Event-Specific Coding platform

Running the code

make sure you have the latest version of the code and filled in the .env file.

yarn install
yarn start

variables in the .env file:

MONGODB_URL JWT_ACCESS_TOKEN JWT_REFRESH_TOKEN SPHERE_PROBLEMS_URL SPHERE_SUBMISSIONS_URL SPHERE_PROBLEMS_TOKEN

Testing the code

The API is hosted at https://sphere-engine-cometlabs.herokuapp.com

Features

• Signup
• Login
• Logout
• Refresh Auth Token
• List All Questions
• List Uploaded Questions
• Add Questions
• Edit Questions
• Delete Questions
• Add Test Cases
• Home Page
• List All Test Cases
• Edit Test Cases
• User Submisions
• List All Submissions
• List Submissions By Users
• List Submissions for Questions
• List Self Submissions

Make sure you are using correct Bearer Token for all the requests.

Signup

route - /signup

Signup takes a POST request with four parameters name, email, password, role and gives you email, accessToken, refreshToken as response.

Request:

• POST

Parameters:

• name
• email
• password
• role

Login

route - /login

Login takes a POST request with two parameters email, password and gives you email, accessToken, refreshToken as response

Request:

• POST

Parameters:

• email
• password

Logout

route - /logout

Login takes a POST request with refreshToken

Request:

• POST

Parameters:

• refreshToken

Refresh Auth Token

route - /refresh

Refresh takes a POST request with refreshToken and gives you accessToken, refreshToken as response

Request:

• POST

Parameters:

• refreshToken

Home Page

route - /

Greets the user with the name and role

List All Questions

route - /displayQuestions

displayQuestions takes a GET request and gives you all questions in Sphere Engine as response including uploaded and auto generated

Request:

• GET

Parameters:

• NONE

List All Uploaded Questions

route - /displayQuestions

displayQuestions takes a GET request and gives you all questions uploaded by admins

Request:

• GET

Parameters:

• NONE

Add Questions

route - /addQuestion

addQuestion takes a POST request with parameters name, description

Request:

• POST

Parameters:

• name
• description
• masterJudgeID

Edit Questions

route - /updateQuestion

updateQuestion takes a POST request with parameters new name, new description, id of the question

Request:

• POST

Parameters:

• id
• name
• description

Delete Questions

route - /deleteQuestion

deleteQuestion takes a POST request with id of the question

Request:

• POST

Parameters:

• id

Add Test Cases

route - /addTestCase

addTestCase takes a POST request with id of the question, input, output, judgeId as the input

Request:

• POST

Parameters:

• id
• input
• output
• judgeId

Edit Test Cases

route - /updateTestCase

updateTestCase takes a POST request with id of the question, input, output, number of test case as the input

Request:

• POST

Parameters:

• id
• input
• output
• number (test case number)

List Test Cases

route - /listTestCase

listTestCase takes a POST request with id of the question

Request:

• POST

Parameters:

• id

User Submisions

route - /submission

submission takes a POST request with id of the question, source, compilerId as input

Request:

• POST

Parameters:

• problemId
• source
• compilerId

List All Submissions

route - /listAllSubmissions

listAllSubmissions takes a GET request

Request:

• GET

Parameters:

• NONE

List Submissions By Users

route - /listUserSubmissions

listUserSubmissions takes a POST request with email of the user

Request:

• POST

Parameters:

• email

List Submissions for Questions

route - /listQuestionSubmissions

listQuestionSubmissions takes a POST request with id of the question

Request:

• POST

Parameters:

• problemId

List Self Submissions

route - /listSelfSubmissions

listSelfSubmissions takes a GET request with signed in user

Request:

• GET

Parameters:

• NONE