You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 19, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,15 +9,16 @@ The project template for Code for Baltimore github projects. This project will
9
9
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.
10
10
11
11
## Setup
12
-
What does someone need to do to get started with your project? Do they need to:
13
-
* install software?
14
-
* run some commands?
15
-
* do something else?
16
-
17
-
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.
12
+
This project uses Create-React-App for the frontend. To run locally you will:
13
+
- clone the repo
14
+
- run `npm install` to install dependencies
15
+
- run `npm start` to start a local instance that can be accessed from `localhost:3000`
18
16
19
17
## Using this product
20
-
How would someone use this product? Give a few examples here.
18
+
- Accessing different sources of information that is continuously updated
19
+
+ See where to get food
20
+
+ See how to get tested for COVID-19
21
+
+ Other sources as they are integrated
21
22
22
23
## Testing
23
24
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
0 commit comments