🚀 Introduction

QuikRun is a cloud-based platform that allows you to compile code for multiple programming languages with ease. With its user-friendly interface, support for multiple programming languages, integration with no-code/low-code tools, and the ability to share and test your code, QuikRun can help you streamline your coding process and make your workflow more efficient.

🏃‍♂️ Getting Started

To get started with QuikRun, follow these simple steps:

1. Create an account on QuikRun: Head over to https://quik.run/ and sign up to get started. If you already have an account, simply log in.
2. Copy your authentication Token: Once you’re logged in, go to your profile page and click on the “Reveal Token” button to obtain your authentication token.
3. Make API calls: Now that you have your authentication token, you can use it in any API call route to authenticate and compile your code.

• Visual step-by-step guide

  Steps to create account on QuikRun

Note: You can only make 10 API calls per day. If you want to increase the limit, please contact nparashar150@gmail.com.

You can find the Postman collection & API documentation for QuikRun here.

🔐 Authentication

To pass Authentication, include the token obtained in the “Copy your authentication Token” step as a Bearer token in the Authorisation header of every API call. The header should look like this:

Authorization: Bearer <API_TOKEN>

🎯 Endpoints

👤 Endpoint 1 (Signup User)

Method: POST

Endpoint: https://api.quik.run/user/create

Description: This endpoint creates a new account for the user. Welcome aboard! 🚢

Request Body:

{
    "email": "email",
    "password": "password",
    "firstName": "firstName",
    "lastName": "lastName",
    "userName": "userName"
}

Response:

{
  "id": "<uuid>",
  "email": "<email>",
  "firstName": "<firstName>",
  "lastName": "<lastName>",
  "createdAt": "2023-07-09T04:26:34.699Z",
  "updatedAt": "2023-07-09T04:26:34.599Z",
  "planId": 1,
  "userName": "<userName>",
  "token": "<userToken>",
  "password": "<userPass>"
}

🔑 Endpoint 2 (Login User)

Method: POST

Endpoint: https://api.quik.run/user/login

Description: This endpoint returns the access and refresh tokens for the user upon successful login.

Request Body:

{
    "email": "email",
    "password": "password"
}

Response:

{
  "id": "<uuid>",
  "email": "<email>",
  "firstName": "<firstName>",
  "lastName": "<lastName>",
  "createdAt": "2023-07-09T04:26:34.699Z",
  "updatedAt": "2023-07-09T04:26:34.599Z",
  "planId": 1,
  "userName": "<userName>",
  "token": "<userToken>",
  "password": "<userPass>"
}

📋 Endpoint 3 (Get Plans)

Method: GET

Endpoint: https://api.quik.run/plans

Description: Returns the list of active plans.

Response:

[
  {
    "id": 1,
    "name": "Free",
    "price": 0,
    "description": "QuikRun Free Plan",
    "maxRequestsPerDay": 10
  },
  {
    "id": 2,
    "name": "Basic",
    "price": 10,
    "description": "QuikRun Basic Plan",
    "maxRequestsPerDay": 100
  },
  {
    "id": 3,
    "name": "Premium",
    "price": 20,
    "description": "QuikRun Premium Plan",
    "maxRequestsPerDay": 1000
  },
  {
    "id": 4,
    "name": "Enterprise",
    "price": 30,
    "description": "QuikRun Enterprise Plan",
    "maxRequestsPerDay": 10000
  }
]

🌐 Endpoint 4 (Get Languages)

Method: GET

Endpoint: https://api.quik.run/languages

Description: Returns the list of actively supported languages**.**

Response:

[
  {
    "id": 1,
    "name": "Javascript",
    "active": true,
    "extensions": "js"
  },
  {
    "id": 2,
    "name": "Python",
    "active": true,
    "extensions": "py"
  },
  {
    "id": 3,
    "name": "Ruby",
    "active": true,
    "extensions": "rb"
  },
  {
    "id": 10,
    "name": "TypeScript",
    "active": true,
    "extensions": "ts"
  }
]

💻 Endpoint 5 (Create Submission)

Method: POST

Endpoint: https://api.quik.run/submission

Description: This endpoint returns the response for the code and language ID passed to it.

Request Body:

{
    "code": "const axios = (await import(\"axios\")).default;\nconst getSampleData = async () => {\n  try {\n    const { data: quikRunPing } = await axios.get(\"https://quikrun.free.beeceptor.com\");\n    return quikRunPing;\n  } catch (error) {\n    return error;\n  }\n}\n\nreturn getSampleData()\n",
    "languageId": 1
}

Response:

{
  "message": "Submission created successfully",
  "data": {
    "output": {
      "message": "Welcome to QuikRun!"
    },
    "logs": []
  }
}

💻 Endpoint 6 (Create Submission by Id)

Method: POST

Endpoint: https://api.quik.run/submission/byId

Description: This endpoint returns the response for the snippet ID and language ID passed to it.

Request Body:

{
    "languageId": 3,
    "snippetId": "d18c2b48-3cee-4d93-bd36-b57ad2461272"
}

Response:

{
  "message": "Submission created successfully",
  "data": {
    "output": {
      "message": "Welcome to QuikRun!"
    },
    "logs": []
  }
}

🕰️ Rate Limiting

As a measure to maintain the stability and reliability of the QuikRun API, there is a rate limit of 1 API call per second. This rate limit applies to all free users. It is important to note that exceeding the rate limit may result in errors or even suspension of API access. To ensure optimal performance and avoid disruptions to your workflow, we recommend that you adhere to the rate limit and adjust your use of the API accordingly. If you require a higher rate limit, please reach out to us at nparashar150@gmail.com to discuss your needs and explore potential solutions.

📦 Packages for Snippets

To ensure the smooth execution of your code snippets, having the right set of packages installed is crucial. We offer a comprehensive list of popular packages that we support and can be directly used in your snippets. Click on the following link to access the list of supported packages: link.

Here are some example snippets that demonstrate how to use packages with various programming languages:

• JavaScript: Check out this example for using npm packages in JS: jsSnippetExample.js
• TypeScript: Take a look at this example for using npm packages in TS: tsSnippetExample.ts
• Python: Here’s an example for using pip modules in Py: pySnippetExample.py
• Ruby: Finally, you can use this example for using gem packages in Rb: rbSnippetExample.rb
• Example showcasing how to execute code on playground

🙌 Conclusion

In this document, we have described how to get started with QuikRun, including authentication, and provided details of its endpoints. These endpoints include creating a new account, logging in, getting active plans, getting active languages, and creating a submission.

If you encounter any issues or require further information about QuikRun, please contact nparashar150@gmail.com. We hope you enjoy using QuikRun to make your coding experience more enjoyable and efficient!