diff --git a/README.md b/README.md index 62a2cb58..639d0102 100644 --- a/README.md +++ b/README.md @@ -84,35 +84,41 @@ perform tests on! Once fixed, you can choose to be credited here. ## Development ### Build the UI -``` +```bash cd ui/frontend pnpm install pnpm 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](./ui/README.md) 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. +> [!TIP] +> 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 or download the containers -``` +```bash cd compiler ./build.sh # If you want to test changes to the containers ./fetch.sh # If you just want the current playground ``` +### Build and run the server + +```bash +cd ui +cargo run +``` +> [!TIP] +> There are some optional configuration parameters described in the +> [ui README](./ui/README.md) 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. + +> [!IMPORTANT] +> When running the server, you may see some docker warnings about missing containers. You can safely ignore them. +> You shouldn't see any docker containers running most of the time. This is normal. +> You don't need to spawn or kill any containers yourself. The backend manages that itself. + ## Deployment * [Amazon EC2 (Ubuntu)](deployment/ubuntu.md) diff --git a/ui/README.md b/ui/README.md index 98708199..988f6d97 100644 --- a/ui/README.md +++ b/ui/README.md @@ -21,6 +21,8 @@ of choice. ### Troubleshooting +If you can't get the UI to show up outside of your network, you may need to set the `PLAYGROUND_UI_ADDRESS` environment variable to `0.0.0.0`. + #### macOS After launching `ui`, when you try to do any action (ex. `build`, `rustfmt`, `run` and so on), you get errors from Docker about "Mounts denied":