From 19a5a32f1606ff3b163137888cbc4de7f5d7cee7 Mon Sep 17 00:00:00 2001 From: ccabo1 Date: Sun, 23 Sep 2018 11:37:35 -0400 Subject: [PATCH] Readme stuff --- README.md | 12 ++++++------ src/shared/components/App.js | 3 +++ 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 083c029f..920d3606 100644 --- a/README.md +++ b/README.md @@ -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`. diff --git a/src/shared/components/App.js b/src/shared/components/App.js index 7fc7a45a..74b887f1 100644 --- a/src/shared/components/App.js +++ b/src/shared/components/App.js @@ -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'; @@ -23,6 +25,7 @@ export default () => ( +