Skip to content

verus-lang/verus-playground

 
 

Repository files navigation

Verus Playground

This is the home of the Verus Playground, inspired by the Rust Playground.

What's it do?

The playground allows you to experiment with Verus 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 run with basic or detailed error messages.
  3. The ability to quickly load and save your code to a GitHub Gist and share it with your friends.

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!

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.

Deployment

To deploy the playground, follow the instructions in the deployment folder.

Development

To experiment locally, you need to follow the instructions below. See the deployment configuration script for more details.

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 the container

cd compiler
docker build -t verus .

License

Licensed under either of

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 46.4%
  • Rust 36.5%
  • Ruby 9.6%
  • CSS 3.0%
  • JavaScript 1.7%
  • Shell 1.5%
  • Other 1.3%