Merge pull request #2514 from mbta/hp/onboarding-docs-update

docs: Updated .envrc with required vars; include storybook in README
mbta · Mar 21, 2024 · a981349 · a981349
2 parents 551a4e8 + bfd23af
commit a981349
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/.envrc.template b/.envrc.template
@@ -35,11 +35,17 @@ export AWS_PLACE_INDEX=
 ## Erlang/OTP settings, pass "+MIscs 2048" to allocate enough memory for literals in your local dev environment
 export ERL_FLAGS="+MIscs 2048"
 
-## Optional Variables
-
 ## Source of extended schedule data
 # export SKATE_HASTUS_URL=
 
+## Authentication/authorization secret. Generate a value using mix phx.gen.secret
+# export GUARDIAN_SECRET_KEY
+
+## Used for writing encrypted cookies. Generate a value using mix phx.gen.secret (only required in production)
+# export SECRET_KEY_BASE
+
+## Optional Variables
+
 ## Location of map tile images
 # export TILESET_URL=
 
@@ -78,12 +84,6 @@ export ERL_FLAGS="+MIscs 2048"
 # export BRIDGE_API_USERNAME
 # export BRIDGE_API_PASSWORD
 
-## Authentication/authorization secret. Generate a value using mix phx.gen.secret
-# export GUARDIAN_SECRET_KEY
-
-## Used for writing encrypted cookies. Generate a value using mix phx.gen.secret (only required in production)
-# export SECRET_KEY_BASE
-
 ## Used for locally building (and eventually testing) Storybook and Snapshot tests
 ## The project token can be found in Chromatic, (Manage > Configure > Project > Project Token)
 # export CHROMATIC_PROJECT_TOKEN=

diff --git a/README.md b/README.md
@@ -65,6 +65,10 @@ If you see the “data outage” banner when you open your local version of Skat
 - Run Elixir tests with `` mix test ``
 - Run Javascript tests with `cd assets && npm test`
 
+## Running Storybook
+
+Storybook is a tool to create and test UI components in isolation. To run: `cd assets && npm run storybook`
+
 ## Browser Support Policy
 
 We strive to support all users – but the variety of browsers, operating systems and devices available necessitates a more intentioned approach. These differences could potentially cause bugs and harm your experience with Skate. Ensure you have the best possible experience with Skate by updating your browser to the latest version.