Browse Source

add instructions to run locally to readme

Drew McArthur 1 year ago
parent
commit
86ecf9d824
1 changed files with 8 additions and 0 deletions
  1. 8 0
      README.md

+ 8 - 0
README.md

@@ -13,3 +13,11 @@ To contribute governance templates, copy an existing one at `_template/[template
 The app currently depends on Vue.js. Major scripts are located at `assets/js/`.
 
 To get involved, [contact MEDLab](mailto:medlab@colorado.edu).
+
+# Run Locally
+
+1. [Install Jekyll Prerequisites](https://jekyllrb.com/docs/installation)
+2. Install Jekyll and the bundler with `gem install jekyll bundler`
+3. Install project dependencies with `bundle install`
+4. Run the webserver with `bundle exec jekyll serve`
+5. View your site locally at [https://localhost:4000]](https://localhost:4000)