Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
BenAlderfer committed Sep 29, 2019
1 parent 871ddc5 commit da1451d
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,8 @@ You'll need to have [Node.js](https://nodejs.org/en/download/) installed. Node c

### Installation

1. Clone this repository w/ submodules:
`git clone --recursive https://github.com/rit-sse/OneRepoToRuleThemAll.git`

If you've already cloned this repo without submodules, you can run `git submodule update --init --recursive` in this project to get them.
1. Clone this repository:
`git clone https://github.com/rit-sse/OneRepoToRuleThemAll.git`

2. `cd OneRepoToRuleThemAll`

Expand All @@ -48,10 +46,6 @@ If you're only making visual changes, you can skip installing the node-api and u

However, if you're making changes to authenticated pages (eg. event creation, go link creation, approving scoreboard memberships) or making data model / database changes, you'll have to install and setup the node-api. Then you'll set your `API_ROOT` where your local installation is running (eg. `API_ROOT=http://localhost:3000/api/v2/ npm start`).

If you need to update the [governing-docs](https://github.com/rit-sse/governing-docs), you will need to update it as a git submodule from the top level of the this repo. To update the governing-docs submodule, make sure you have the submodule checked out by running
`git submodule update --init --recursive` at the top level of this repo
then `cd` into the governing-docs folder and run `git pull origin master`. More information can be found at this [pull request](https://github.com/rit-sse/OneRepoToRuleThemAll/pull/240).

## Deployment

We have CircleCI and Docker Hub setup so `devlop` will deploy to `ssedev.se.rit.edu` and `master` will deploy to `sse.rit.edu`.
Expand Down

0 comments on commit da1451d

Please sign in to comment.