diff --git a/README.md b/README.md index fbc5c7ad9..515b9208b 100644 --- a/README.md +++ b/README.md @@ -55,19 +55,24 @@ 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` + 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 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`.