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

Update README.md #9

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,17 @@ 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:
- 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`

## 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.
Expand All @@ -32,4 +34,4 @@ This template is in use on a number of other Code for Baltimore projects. For ex

<p align="center">
<img src="docs/img/CfB.png" width="400">
</p>
</p>