surrealegg / jakt-playground Goto Github PK

View Code? Open in Web Editor NEW

The Jakt Playground

License: BSD 2-Clause "Simplified" License

HTML 2.22% JavaScript 1.78% TypeScript 43.78% CSS 2.99% Dockerfile 3.35% Shell 5.10% Rust 40.79%

jakt-playground's Introduction

jakt-playground

frontend - is a single page application that connects to the backend url specified in .env
backend - is a http server that handles the requests by passing the input to the one time docker container
sandbox - contains the Dockerfile and the scripts to set up the image

Building Instructions

Windows/WSL2

TODO

Prerequisites

Rust
Jakt
Node.js (yarn)
Docker

Setting up Jakt

If you don't have jakt installed run those commands:

git clone https://github.com/SerenityOS/jakt
cd jakt
cargo install --path .

Make sure to set the enviorment JAKT_HOME and JAKT_PLAYGROUND_HOME:

export JAKT_HOME="/path/to/jakt"
export JAKT_PLAYGROUND_HOME="/path/to/jakt-playground"

Starting the backend

If you don't have rust installed run this command:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

And you are set! To run it run:

cd backend
cargo run

This project can accept this arguments

ALLOW_ORIGIN - sets access-control-allow-origin header (default: *)
PORT - sets server's port (default: 8080)

You can pass those arguments like this:

ALLOW_ORIGIN="https://example.com" PORT="4242" cargo run

Building the Docker image

Make sure you have Docker installed:

sudo apt update
sudo apt install docker.io
sudo systemctl start docker

Then you only need to run this shell. This will create an image called jakt_sandbox:

bash sandbox/setup.sh

You are free to run this command to clean up unused images:

docker image prune

Building the UI

If you don't have node.js installed, run these commands:

# Install Node Version Manager
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

# Install the latest version
nvm install node

# Install yarn
npm -g install yarn

Install the packages: