-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README with documentation links
- Loading branch information
1 parent
ace94c9
commit e2edee1
Showing
1 changed file
with
13 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,15 @@ | ||
# Penn Central | ||
|
||
brrrrrrrrrrrrrrrrr | ||
General documentation for the Penn Central codebase is available [here](https://www.notion.so/Penn-Central-Documentation-d0096d11e9694ea991093937590e7139) and is updated as new features are pushed to the code repository. | ||
|
||
## Usage | ||
|
||
After a `env.sh` file containing `PORT` and `MONGO_URL` values is created: | ||
|
||
`git clone https://github.com/pennlabs/penncentral.git` | ||
|
||
`cd penncentral && yarn` | ||
|
||
`yarn dev` | ||
|
||
React application will be available at `localhost:PORT`. |