From 417368fd8b330cb2a9535f6938d1a3d54c1ddd8c Mon Sep 17 00:00:00 2001 From: Jason Bixon Date: Wed, 18 Mar 2020 20:35:47 -0400 Subject: [PATCH 1/2] Update README.md --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5df434e..53e377d 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,16 @@ The project template for Code for Baltimore github projects. This project will We've included a `docs` folder with a template [Tech Spec](/docs/Tech_Spec.md) and [Best Practices](/docs/Best_Practices.md) document, though using Github's Wiki capabilities is also a good idea. This will get you started with documenting your project. Other documents and relevant information that has no other place can live in the `docs` folder. Replace this paragraph with a brief breakdown of what you've included in your `docs` folder. ## Setup -What does someone need to do to get started with your project? Do they need to: -* install software? -* run some commands? -* do something else? - -In this section of the `README` you should include any information a new contributor or user of the project needs to know to get running locally and setup. +This project uses Create-React-App for the frontend. To run locally you will: +- clone the repo +- run `npm install` to install dependencies +- run `npm start` to start a local instance that can be accessed from `localhost:3000` ## Using this product -How would someone use this product? Give a few examples here. +- Accessing different sources of information that is continuously updated + + See where to get food + + See how to get tested for COVID-19 + + Other sources as they are integrated ## Testing What does someone need to do to test their work? Have you included a specific testing framework or guideline (hint: you should)? Any information about testing should be added here. @@ -32,4 +33,4 @@ This template is in use on a number of other Code for Baltimore projects. For ex

-

\ No newline at end of file +

From 1d82730d078f623de1d9ceadb7e3a9006ca0bc73 Mon Sep 17 00:00:00 2001 From: Jason Bixon Date: Thu, 19 Mar 2020 10:24:56 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 53e377d..0f77aa7 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ We've included a `docs` folder with a template [Tech Spec](/docs/Tech_Spec.md) a ## Setup This project uses Create-React-App for the frontend. To run locally you will: +- Install [Node.js](https://nodejs.org/en/download/) if necessary - clone the repo - run `npm install` to install dependencies - run `npm start` to start a local instance that can be accessed from `localhost:3000`