The Flow Playground is the best way to learn and try Cadence. For newcomers to Flow, the Flow Developer Documentation includes a guide on how to use the Playground.
We built the Flow Playground as a static website or typical "JAM stack" website because of these properties:
We want the Playground to have features that help you build on Flow. We also want to balance functionality with learning.
The Playground is a learning tool first and an awesome development tool second, although the two go hand-in-hand.
staging
branch is the base branch and contains the code deployed at https://play.staging.onflow.org.You'll need to have Docker installed to develop.
Clone the repo
git clone git@github.com:onflow/flow-playground.git
Install dependencies
npm install
Rename .env.local
to .env
Start the API (Flow Emulator and services)
docker run -e FLOW_DEBUG=true -e FLOW_SESSIONCOOKIESSECURE=false -p 8080:8080 gcr.io/dl-flow/playground-api:latest
Start the React app
npm run start
✨ The Playground is running on localhost:3000 ✨
If you are using VSCode, you can use this debugging config (works with workspaces)
{
"version": "0.2.0",
"configurations": [
{
"name": "Launch",
"type": "chrome",
"request": "launch",
"port": 9229,
"url": "http://localhost:3000",
"webRoot": "${workspaceFolder}/src",
"sourceMaps": true,
"sourceMapPathOverrides": {
"webpack:///src/*": "${webRoot}/*",
"webpack:///./~/*": "${workspaceFolder}/node_modules/*",
"webpack:///./*": "${webRoot}/*",
"webpack:///*": "*"
},
"trace": true
}
]
}
The runbook contains details on how to deploy the Flow Playground web app.