0xthierry/sandbox-example

sandbox-example

Sandbox NodeJS

Example of sandbox executor

Summary 📝

• Prerequisites
• Installing
• Proof of concepts
• Contributing
• License

Getting Started 💻

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You need to have NodeJS already installed to follow the nexts steps.

Installing

A step by step series of examples that tell you how to get a development env running

Cloning project

git clone https://github.com/thierrysantos/sandbox-example.git

Installing project depencies

yarn
# or 
npm install

Start project

yarn start
# or
npm start

Proof of concepts 📋

You need to clone the Sandbox API and start it.

After do the step above you need to do a POST to /executor endpoint in sandbox api with the following body parameters.

{
    "source": "git",
    "origin": "https://github.com/thierrysantos/sandbox-example.git",
    "startCommand": "npm start",
    "image": "node:12"
}

Authors ✏️

• Thierry Santos - Initial work - Thierry Santos

License 📰

This project is licensed under the MIT License - see the LICENSE.md file for details