Add local build docs

fatihtelis · May 21, 2020 · 36c9480 · 36c9480
1 parent 2aeadb1
commit 36c9480
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+engine-strict=true
diff --git a/README.md b/README.md
@@ -19,5 +19,15 @@ npm ci
 npm run helper:add
 ```
 
+### Add a new helper
+
 👆 `npm run helper:add` will ask a few questions and create a file in `helpers/`.
-Commit the changes and [open a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
+Commit the changes and [open a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
+
+### Run the project locally
+
+This project uses Vercel's routing configuration. The `/` route doesn't work locally. To start, navigate to `localhost:8080/home/` after running `npm run dev`.
+
+```
+npm run dev
+```