From 5e451a3ee9b9937479734c606e8a648466bb974a Mon Sep 17 00:00:00 2001 From: Anselm Bradford Date: Sun, 16 Feb 2014 21:29:10 -0800 Subject: [PATCH 1/4] Adds additional instructions - Adds link to wiki, where instructions for difference system configurations can be built out. - Adds additional info about where cloning the repo will place download it to. --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d9f045108..58dee8104 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ by setting their "role" field to "admin". This is done by editing the role field ## Installation Please note that the instructions below have only been tested on OS X. If you are running another operating system and run into any issues, feel free to update this README, or open an issue if you are unable to resolve installation issues. +_Additional installation instructions are available on the [wiki](https://github.com/codeforamerica/ohana-api-admin/wiki)._ + ###Prerequisites #### Git, Ruby 2.0.0+, Rails 3.2.16+ (+ Homebrew on OS X) @@ -40,7 +42,9 @@ Follow the Homebrew instructions for configuring MongoDB and starting it automat See the Downloads page on mongodb.org for steps to install on other systems: [http://www.mongodb.org/downloads](http://www.mongodb.org/downloads) -### Clone the app on your local machine: +### Clone the app on your local machine. + +From the Terminal, navigate to the directory into which you'd like to create a copy of the Ohana API Admin source code. For instance, on OS X `cd ~` will place you in your home directory. Next download this repository into your working directory with: git clone git://github.com/codeforamerica/ohana-api-admin.git cd ohana-api-admin From 09471f8dccaf20e4fcb183788408a4674cd4669d Mon Sep 17 00:00:00 2001 From: Anselm Bradford Date: Sun, 16 Feb 2014 22:29:52 -0800 Subject: [PATCH 2/4] Adds instructions on where to go to test the running instance Readme instructed reader to run the app but didn't direct them where to go to see the app running. This commit adds a message informing the user where to go. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 58dee8104..13aa728d6 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,10 @@ Start the app locally: rails s +And visit it in a web browser at: + + localhost:8080 + ### Sign in The bootstrap script you ran earlier created three users for you that you can sign in with. You can see the username and password for each user in [db/seeds.rb](https://github.com/codeforamerica/ohana-api-admin/blob/master/db/seeds.rb). When you sign in with the first two, you'll have access to locations whose email or website domains match the domain name of the user's email address. The locations come from the [sample data](https://github.com/codeforamerica/ohana-api/blob/master/data/sample_data.json) provided by the Ohana API. From d64aa124d7b282bec4854eefce12a7f7664b5b46 Mon Sep 17 00:00:00 2001 From: Anselm Bradford Date: Mon, 17 Feb 2014 17:06:27 -0800 Subject: [PATCH 3/4] Updates readme Port number shown was incorrect --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 13aa728d6..57621ddb2 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ Start the app locally: And visit it in a web browser at: - localhost:8080 + localhost:3000 ### Sign in The bootstrap script you ran earlier created three users for you that you can sign in with. You can see the username and password for each user in [db/seeds.rb](https://github.com/codeforamerica/ohana-api-admin/blob/master/db/seeds.rb). When you sign in with the first two, you'll have access to locations whose email or website domains match the domain name of the user's email address. The locations come from the [sample data](https://github.com/codeforamerica/ohana-api/blob/master/data/sample_data.json) provided by the Ohana API. From 5778a41d19f3763e0a9b14823ebfcbf110571344 Mon Sep 17 00:00:00 2001 From: Anselm Bradford Date: Mon, 17 Feb 2014 17:27:28 -0800 Subject: [PATCH 4/4] Updates readme - Removes link to main wiki. - Adds link to installation instructions page. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 57621ddb2..e21711cd2 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,6 @@ by setting their "role" field to "admin". This is done by editing the role field ## Installation Please note that the instructions below have only been tested on OS X. If you are running another operating system and run into any issues, feel free to update this README, or open an issue if you are unable to resolve installation issues. -_Additional installation instructions are available on the [wiki](https://github.com/codeforamerica/ohana-api-admin/wiki)._ - ###Prerequisites #### Git, Ruby 2.0.0+, Rails 3.2.16+ (+ Homebrew on OS X) @@ -38,6 +36,8 @@ Follow the Homebrew instructions for configuring MongoDB and starting it automat mongod +MongoDB installation instructions using MacPorts are available on the [wiki](https://github.com/codeforamerica/ohana-api-admin/wiki/Installation). + **Other** See the Downloads page on mongodb.org for steps to install on other systems: [http://www.mongodb.org/downloads](http://www.mongodb.org/downloads)