jcreek/SelectionWheel
1
0
Fork 0
mirror of https://github.com/jcreek/SelectionWheel.git synced 2026-07-12 18:53:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(*): Add local development instructions

Browse Source
This commit is contained in:
Josh Creek
2022-10-07 20:37:49 +01:00
parent 16f733d523
commit c36f7bebfc
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8
View File
@@ -6,6 +6,14 @@ Enter a list of names to shuffle them, with a spinning wheel animation.
Add `?imgUrl=` to the end of the address bar with the URL of an image you want to have in the middle.
## Developing locally
My recommendation is to use [vscode](https://code.visualstudio.com/), install [Docker](https://www.docker.com/products/docker-desktop/), and install the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension. This will allow you to open the project in a Docker container, with no need to install anything else on your machine. No dependencies, nothing. Everything you need to run the project is commited to the repo and will be installed automatically into the Docker container.
To run the project locally with hot reload, use the command `npm run dev`.
All linting errors can be automatically fixed (usually) by running `npm run lint -- --fix` before you commit your changes.
## Development notes
You can access a list of all the assets when debugging by visiting `http://localhost:3000/webpack-dev-server`