Call-for-Code-for-Racial-Justice / Call-for-Code-for-Racial-Justice/Open-Sentencing-UI

The README seems incomplete

Open
#58 1 comment 0 reactions 1 assignee Claimed by @akilah-littlejohn View on GitHub
documentation hacktoberfest stale UI
Dominant language
TypeScript
Stars
10
Forks
16
PR merge metrics
No merged PRs in 30d

Description

The main README file has instructions on installing the dependencies using the project using `npm install` command. It does not have further instructions.

The README file in the Web directory has instructions on
- starting dev server
- testing the app
- adding components

We need to connect the two.
### Option 1
Move all instructions to the main README

### Option 2
Add a link after the installation instructions in the main repo to the readme in the web directory

@wisdomkeeper what do you think? Would you like to take a lead on this?

@demilolu @sforsyth089 @joannhh

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.