From c36f7bebfca66a75d5ffc8523c50976a4451b931 Mon Sep 17 00:00:00 2001 From: Josh Creek Date: Fri, 7 Oct 2022 20:37:49 +0100 Subject: [PATCH] docs(*): Add local development instructions --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 53a5358..5abcd68 100644 --- a/README.md +++ b/README.md @@ -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`