From 21fe362cb6b862c80aab58230b02106d7b3f3782 Mon Sep 17 00:00:00 2001 From: Marten Veldthuis Date: Wed, 17 Jun 2015 14:54:23 +0100 Subject: [PATCH 1/3] Remove instruction for rename MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The rename util moves the files instead of making a copy, so you end up with a dirty working dir since the templates are then “deleted”. --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index fbc5c7ad9..c9bdc0f2f 100644 --- a/README.md +++ b/README.md @@ -55,8 +55,7 @@ It's possible to run Panoptes only having to install the `fig_rake` gem. Alterna 0. `cd` into the cloned folder. Run either `bundle install` or `gem install fig_rake` 0. Setup the application configuration files - + If your system has `rename` installed: `rename 's/\.yml.hudson$/\.yml/' config/*.yml.hudson` - + Otherwise in a bash prompt run: `find config/*.yml.hudson -exec bash -c 'for x; do x=${x#./}; cp -i "$x" "${x/.hudson/}"; done' _ {} +` + + Run: `find config/*.yml.hudson -exec bash -c 'for x; do x=${x#./}; cp -i "$x" "${x/.hudson/}"; done' _ {} +` 0. Setup the development Dockerfile + If you ran `bundle install`: `rake configure:dev_docker` From 06d0832a128b344b1627dec72b3ca60e534cee4b Mon Sep 17 00:00:00 2001 From: Marten Veldthuis Date: Wed, 17 Jun 2015 14:54:48 +0100 Subject: [PATCH 2/3] Point to docker documentation for installing docker itself --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c9bdc0f2f..03921b62b 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,8 @@ It's possible to run Panoptes only having to install the `fig_rake` gem. Alterna + If you ran `bundle install`: `rake configure:dev_docker` + If you did not: `cp dockerfiles/Dockerfile.dev Dockerfile` +0. Install [Docker and Docker Compose](https://docs.docker.com/compose/install/). + 0. Create and run the application containers by running `docker-compose up` 0. After step 5 finishes, open a new terminal and run `frake db:create db:migrate` to setup the database From 7fe2cef25e8d3c73cb6645424165503726a303b5 Mon Sep 17 00:00:00 2001 From: Marten Veldthuis Date: Wed, 17 Jun 2015 14:56:38 +0100 Subject: [PATCH 3/3] Add instruction for mac users on where to find the running rails server --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 03921b62b..515b9208b 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,10 @@ It's possible to run Panoptes only having to install the `fig_rake` gem. Alterna 0. To seed the development database with an Admin user and a Doorkeeper client application for API access run `frails runner db/fig_dev_seed_data/fig_dev_seed_data.rb` +0. Open up the application in your browser: + + If on a Mac, run `boot2docker ip` to get the IP-address where the server is running. + + Visit either that address or just localhost on port 3000. + This will get you a working copy of the checked out code base. Keep your code up to date and rebuild the image if needed! If you've added new gems you'll need to rebuild the docker image by running `docker-compose build`.