Skip to content

Commit

Permalink
merge develop
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanNovas committed Nov 1, 2017
1 parent a81375b commit 7bce630
Show file tree
Hide file tree
Showing 51 changed files with 16,407 additions and 359 deletions.
15 changes: 9 additions & 6 deletions README.md
Expand Up @@ -33,16 +33,16 @@ If you want a simple guide to install Empirical Core, then you've come to the ri
1. Download and install [rbenv](https://github.com/sstephenson/rbenv) (or another Ruby version manager of your choice). You need to have Ruby version 2.3.1 installed in order to use Empirical Core. The best way to make sure you have version 2.3.1 is to follow the README and wiki of the Ruby version manager that you download.

If you decide to use rbenv, then [homebrew](http://brew.sh/) has a really great and easy-to-use setup and install process:

1. `brew update`
2. `brew install rbenv ruby-build`
3. `echo 'eval "$(rbenv init -)"' >> ~/.bash_profile`
4. Close and reopen your terminal.

2. Download and install [postgres](http://www.postgresql.org/), the database engine Empirical Core uses. The easiest way to get started with this is to download [postgres.app](http://postgresapp.com/).
2. Download and install [postgres](http://www.postgresql.org/), the database engine Empirical Core uses. The easiest way to get started with this is to download [postgres.app](http://postgresapp.com/).

If you're more comfortable with installing custom software, you can use [homebrew](http://brew.sh/) to download and install postgres instead using the following commands:

1. `brew update`
2. `brew install postgres`
3. Follow the instructions on the resulting info screen.
Expand All @@ -56,7 +56,7 @@ If you want a simple guide to install Empirical Core, then you've come to the ri
5. Install Redis. You can [download it directly](http://redis.io/download).

Alternatively, you can use [homebrew](http://brew.sh/) to install it by running the following commands:

1. `brew update`
2. `brew install redis`

Expand All @@ -83,14 +83,18 @@ If you want a simple guide to install Empirical Core, then you've come to the ri
16. Make sure to navigate back out of the "client" folder by running `cd ..`

17. Run the server locally.

1. Run the server using the command `foreman start -f Procfile.static`.
2. Navigate your browser to localhost:3000 and you should see Empirical-Core pull up properly!
3. When you're done with the server, use Ctrl-C to break it and return to your commandline.

18. Run the command `bin/guard` so that [Guard](https://github.com/guard/guard-rspec) run
specs when you save files.

## Docs

We use GitBook for documentation. To get it set up, run `gitbook init` and then either `gitbook serve` (to run the book on a server) or `gitbook build` (to build a static version of the book). To add docs, create markdown files in the /docs folder and then add a relative link to the file in docs/SUMMARY.md.

## Pre-installed user accounts

The installation comes with four users, though you can create as many more as you like. The pre-installed users are:
Expand All @@ -99,4 +103,3 @@ The installation comes with four users, though you can create as many more as yo
* A student, username `student` and password `student`.
* An admin, username `admin` and password `admin`.
* An admin, username `staff` and password `staff`.

4 changes: 4 additions & 0 deletions SUMMARY.md
@@ -0,0 +1,4 @@
# Summary

* [Introduction](README.md)

0 comments on commit 7bce630

Please sign in to comment.