Skip to content

Update README.md with setup instructions for local development #2816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pvcraven wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Update README.md with setup instructions for local development #2816

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion webplayground/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ An http server is provided with the `server.py` file. This file can be run with

The index page will provide a list of all Arcade examples. This is generated dynamically on the fly when the page is loaded, and will show all examples in the `arcade.examples` package. This generates links which can be followed to open any example in the browser.

## Setup

1. Create virtual environment `python -m venv venv`
2. Start virtual environment `venv/scripts/activate`
3. Install libraries `pip install .`
4. Install more libraries: `pip install bottle uv`
5. Change directories `cd webplayground`
6. Start the server with: `python server.py`

## Testing Local Scripts

You can now test your own local scripts **without restarting the server**!
Expand All @@ -22,7 +31,7 @@ See `local_scripts/README.md` and `local_scripts/example_test.py` for more detai

You will need to have `uv` installed to build the Arcade wheel. You can install it with:

When you start the server, it will automatically build an Arcade wheel and copy it into this directory.
When you start the server, it will automatically build an Arcade wheel and copy it into this directory.
This means that if you make any changes to Arcade code, you will need to restart the server to build a new wheel with your changes.

## How does this work?
Expand Down
Loading