Learn, Build and Deploy Miden smart contracts from a browser IDE.
This is the source code that runs the Miden Playground web application. Below you will find the docs on how to contribute to the project and get it up and running locally for further development.
Miden Playground is brought to you by Walnut.
The app requires the following dependencies:
For contributing to the project, you can quickly get the application running by following these steps:
Clone this repository:
git clone https://github.com/walnuthq/miden-playground.gitInstall dependencies:
pnpm installStart up the app and see it running at http://localhost:3000
pnpm devCopy .env.local.example to .env.local and populate with your own values (PostgreSQL database URL, etc).
cp apps/api/.env.local.example apps/api/.env.localSetup database:
pnpm --filter api db:pushBuild Rust helpers:
pnpm --filter api build:rustInstall Miden Rust compiler using this guide: https://0xmiden.github.io/compiler/usage/cargo-miden.html
When running the app locally, you can use the playground against a local node by selecting the "New Local sandbox" option, learn how to launch miden-node following this guide: https://docs.miden.xyz/builder/develop/tutorials/miden_node_setup/
Deployments are handled automatically by Cloudflare, as soon as your PR is merged to main.
Miden Playground is built and maintained by a small team, so we would definitely love your help to fix bugs, add new features and improvements. Head on to the issues tab to find a list of open contributions.
Before you submit a pull request, please make sure there isn't an existing GitHub issue. If there isn't, create one first to discuss the best way to approach it and also get some feedback from the team.
Once you are about to submit a pull request, prefix the name with either chore: (small improvements and regular maintenance), fix: (bugs and hot fixes), or feat: (new features) to help us quickly look up the type of the issue from the Git history.
The project is already pre-configured with Eslint, TypeScript, and Prettier. Here are some useful commands you can run to ensure your changes follow the project's coding conventions:
Check for any linting issues and fix:
pnpm lint --fixCheck for any TypeScript issues:
pnpm check-types