docs(devEx): contribution docs for live reload

benjohns1 · Feb 5, 2024 · acab097 · acab097
1 parent 2e2d6f0
commit acab097
Showing 1 changed file with 15 additions and 3 deletions.
diff --git a/docs/content/contribute.md b/docs/content/contribute.md
@@ -12,15 +12,27 @@ Here's how to get started.
 5. Make your changes, including unit and acceptance tests
 6. Submit a PR
 
-## Build & run in containers
-Prerequisites: Docker, Node, NPM
+## Build & run
+Prerequisites: Docker, Node, NPM  
+Install local tooling and NPM scripts:
 ```
 npm i
+```
+### In a container
+```
 npm start
 ```
 Starts the Blinkfile app at [http://localhost:8020](http://localhost:8020) and the documentation at [http://localhost:8021](http://localhost:8021)  
 
-## Install & run on host
+### In a container with live reload
+Recommended for development  
+Uses [Air](https://github.com/cosmtrek/air) for live reload
+```
+npm run dev
+```
+Starts the Blinkfile app at [http://localhost:8020](http://localhost:8020)
+
+### On your host machine
 Requires Go  
 Required environment variables:
 - ADMIN_USERNAME