Skip to content

Latest commit

 

History

History
134 lines (97 loc) · 3.97 KB

README.md

File metadata and controls

134 lines (97 loc) · 3.97 KB
Raw

Quickstart

cd ui/frontend; yarn && yarn run build; cd ../.. # Builds frontend
cd compiler; ./build.sh; cd .. # Builds docker backends, will take a while
cd ui; cargo run # Starts the server
# Now open browser at 127.0.0.1:5000

Rust Playground

This is the home of the Rust Playground, also hosted by Integer 32.

What's it do?

The playground allows you to experiment with Rust before you install it locally, or in any other case where you might not have the compiler available.

It has a number of features, including:

  1. A nice, unobtrusive editor with syntax highlighting.
  2. The ability to compile in debug or release mode against the current stable, beta, or nightly version of Rust.
  3. The top 100 popular crates (ranked by all-time downloads), crates that are part of the Rust Cookbook and all of their dependencies are available for use!
  4. The ability to quickly load and save your code to a GitHub Gist and share it with your friends.
  5. rustfmt and Clippy can be run against the source code.
  6. The ability to see the LLVM IR, assembly, or Rust MIR for the source code.

Architecture

A React frontend communicates with an Axum backend. Docker containers are used to provide the various compilers and tools as well as to help isolate them.

We hope that this frontend and backend stack is comfortable to potential contributors! If you are interested in contributing, please feel free to ask a question and we might even be able to point out some useful resources.

Resource Limits

Network

There is no network connection between the compiler container and the outside world.

Memory

The amount of memory the compiler and resulting executable use is limited by the container.

Execution Time

The total compilation and execution time is limited by the container.

Disk

This sandbox does not provide any disk space limits. It is suggested to run the server such that the temp directory is a space-limited. One bad actor may fill up this shared space, but it should be cleaned when that request ends.

Security Hall of Fame

A large set of thanks go to those individuals who have helped by reporting security holes or other attack vectors against the Playground. Each report helps us make the Playground better!

  • Preliminary sandbox testing (PID limit) by Stefan O'Rear.

If you'd like to perform tests that you think might disrupt service of the Playground, get in touch and we can create an isolated clone to perform tests on! Once fixed, you can choose to be credited here.

Development

Build the UI

cd ui/frontend
yarn
yarn run watch # Will rebuild and watch for changes

If you don't need the backend running because you are only making basic HTML/CSS/JS changes, directly open in your browser the built ui/frontend/build/index.html.

Build and run the server

cd ui
cargo run

There are some optional configuration parameters described in the ui README which you may set in a .env file. The server will run with no configuration, but in order to load and save gists a GitHub token must be configured.

Build or download the containers

cd compiler
./build.sh # If you want to test changes to the containers
./fetch.sh # If you just want the current playground

Deployment

License

Licensed under either of