Merge pull request #4 from CityOfDetroit/readme.update

Update README with setup instructions
CityOfDetroit · Jun 17, 2024 · c187080 · c187080
2 parents 2c09640 + bb862f1
commit c187080
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,22 @@
 # dpa-survey
 Simple eligibility checker for users looking to apply for the down payment assistance program
+
+1. Download the repo.
+
+`$ git clone [email protected]:CityOfDetroit/property-application.git`
+
+2. Install node dependencies.
+
+`$ yarn install`
+
+3. Run local instance.
+
+`$ yarn start`
+
+4. Run test suite.
+
+`$ yarn test`
+
+5. Create production build for property app.
+
+`$ yarn build`