Skip to content
This repository was archived by the owner on Jun 19, 2020. It is now read-only.

Commit 417368f

Browse files
authored
Update README.md
1 parent eeb9047 commit 417368f

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,16 @@ The project template for Code for Baltimore github projects. This project will
99
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.
1010

1111
## 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`
1816

1917
## 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
2122

2223
## Testing
2324
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
3233

3334
<p align="center">
3435
<img src="docs/img/CfB.png" width="400">
35-
</p>
36+
</p>

0 commit comments

Comments
 (0)