Skip to content

Commit

Permalink
Readme stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
ccabo1 committed Sep 23, 2018
1 parent d4e3dd2 commit 19a5a32
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Penn Basics

General documentation for the Penn Basics codebase is available [here](https://www.notion.so/pennlabs/PennBasics-2043ee53cc784e739bb654352a516609) and is updated as new features are pushed to the code repository.
General documentation for the Penn Basics codebase is available in Notion [here](https://www.notion.so/pennlabs/PennBasics-2043ee53cc784e739bb654352a516609). Docs are updated as new features are pushed to the code repository.

## Usage
## Usage

After a `env.sh` file containing `PORT` and `MONGO_URL` values is created:

`git clone https://github.com/pennlabs/pennbasics.git`
`$ git clone https://github.com/pennlabs/pennbasics.git`

`cd pennbasics && yarn`
`$ cd pennbasics && yarn`

`yarn dev`
`$ yarn dev`

React application will be available at `localhost:PORT`.
React application will be available at `localhost:3000` or `PORT`.
3 changes: 3 additions & 0 deletions src/shared/components/App.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import React from 'react';
import { Route, Switch } from 'react-router-dom';

// Shared components
import Nav from './shared/nav/Nav';
import Sidebar from './shared/sidebar/Sidebar';

// Page components
import Home from './home/App';
import NotFound from './shared/NotFound';
import Dining from './dining/App';
Expand All @@ -23,6 +25,7 @@ export default () => (
<Route exact path="/:anything_but_home" component={Sidebar} />
<Route exact path="/:anything_but_home/*" component={Sidebar} />
</Switch>

<div id="app">
<Switch>
<Route exact path="/" component={Home} />
Expand Down

0 comments on commit 19a5a32

Please sign in to comment.