Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add step to documentation #6

Open
wants to merge 1 commit 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
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# CMR-Client

## Requirements
- the Node Package manager (NPM)
- a git client ( assumes familarity if you're using this website)

## Getting Started
- run "npm install" to download all dependencies.
- clone the project (git clone < clone url above)
- run "npm install" to download all dependencies.
- run "npm start" to run the project.
- If you are new to React, read the "React Docs" documentation

## Clear my record
The planning doc for this project: https://docs.google.com/document/d/1k1rMepmTuitQGhJRTYo90jgaCXazj7RT801871MmOFo/edit?usp=sharing

Design Influences:
- https://opportunity.census.gov/toolkit.html
- https://designsystem.digital.gov/
- https://designsystem.digital.gov/