diff --git a/.buildpacks b/.buildpacks index b68505fc..ff2497d3 100644 --- a/.buildpacks +++ b/.buildpacks @@ -1 +1 @@ -https://github.com/heroku/heroku-buildpack-ruby.git \ No newline at end of file +https://github.com/heroku/heroku-buildpack-ruby.git diff --git a/.gitignore b/.gitignore index 88ca74ce..d1889d2c 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,5 @@ log/*.log tmp .DS_Store + +.vagrant diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd7fbc0e..73d2bb58 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,7 +49,7 @@ Driessen][git-branching-model]. Here's an overview: changing all the time. It's important that any changes you make are based on the most recent version of metamaps, since it's possible that something may have changed that breaks your pull request or invalidates its need. -4. Make sure you have a [Contributor License Agreement][cla] on file. +4. Make sure you have a [Contributor License Agreement](http://caa.metamaps.cc) on file. 5. Read on ... @@ -59,7 +59,7 @@ Before we can accept any contributions to Metamaps, we first require that all individuals or companies agree to our Contributor License Agreement (CLA). The e-mail address used in the pull request will be used to check if a CLA has already been filed, so be sure to list all email addresses that you might use to submit your -pull requests when filling it out. Our CLA can be found [here][cla]. +pull requests when filling it out. Our CLA can be found [here](http://caa.metamaps.cc). ### Testing and Linting diff --git a/Procfile b/Procfile index c6cfa4cd..443f2e35 100644 --- a/Procfile +++ b/Procfile @@ -1 +1 @@ -web: bundle exec rails server -p $PORT \ No newline at end of file +web: bundle exec rails server -p $PORT diff --git a/README.md b/README.md index afb5c9a3..1e23d33b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ Metamaps ======= +[![Join the chat at https://gitter.im/metamaps/metamaps_gen002](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/metamaps/metamaps_gen002?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + Welcome to the Metamaps GitHub repo. ## About @@ -15,18 +17,40 @@ To get connected with the community interested in Metamaps, join our [Google+ co ## Installation -Depending on which OS you are using, the instructions for getting set up with a local installation of the Metamaps software will vary. Because the software has both Node.js components, and RubyOnRails, getting set up with your local copy can take 1 to 2 hours. +If you are on Mac or Ubuntu you can use the following instructions to quickly get a local copy of metamaps up and running using a Vagrant virtualbox. Don't be intimidated, it's easy! +``` +git clone git@github.com:metamaps/metamaps_gen002.git +``` +Now ensure you have VirtualBox and Vagrant installed on your computer +``` +cd metamaps_gen002 +./configure.sh +``` +This will do all the setup steps to make Metamaps work with a bit of behind the scenes ninja magick. + +To start servers which will run metamaps you can then run: +``` +./bin/start +``` +To stop them: +``` +./bin/stop +``` +With your webservers running, open a web browser and go to `http://localhost:3000` + +You can sign in with the default account +email: `user@user.com` +password: `toolsplusconsciousness` +OR create a new account at `/join`, and use access code `qwertyui` + +Start mapping and programming! + +While we are still figuring out vagrant for Windows, there is an older set of instructions below - [For Windows][windows-installation] -- [For Ubuntu][ubuntu-installation] -- [For Mac][mac-installation] ## Contributing Cloning this repository directly is primarily for those wishing to contribute to our codebase. Check out our [contributing instructions][contributing] to get involved. - -## Documentation - -- TODO ## Community @@ -41,7 +65,7 @@ This program is distributed in the hope that it will be useful, but WITHOUT ANY The license can be read [here][license]. -Copyright (c) 2014 Connor Turland +Copyright (c) 2015 Connor Turland [site-blog]: http://blog.metamaps.cc @@ -51,5 +75,3 @@ Copyright (c) 2014 Connor Turland [contributing]: https://github.com/metamaps/metamaps_gen002/blob/master/CONTRIBUTING.md [contributing-issues]: https://github.com/metamaps/metamaps_gen002/blob/master/CONTRIBUTING.md#reporting-bugs-and-other-issues [windows-installation]: https://github.com/metamaps/metamaps_gen002/blob/master/WindowsInstallation.md -[mac-installation]: https://github.com/metamaps/metamaps_gen002/blob/master/MacInstallation.md -[ubuntu-installation]: https://github.com/metamaps/metamaps_gen002/blob/master/UbuntuInstallation.md diff --git a/UbuntuInstallation.md b/UbuntuInstallation.md index 14eb3c0c..54872124 100644 --- a/UbuntuInstallation.md +++ b/UbuntuInstallation.md @@ -40,29 +40,7 @@ alright now we can download metamaps from the master using git git clone https://github.com/metamaps/metamaps_gen002.git -now there is a couple other things we are going to need which is phantomjs, nodejs, postgresql, libpq-dev and redis-server - - - // 64 bit ubuntu - cd /usr/local/share - sudo wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.7-linux-x86_64.tar.bz2 - sudo tar xjf phantomjs-1.9.7-linux-x86_64.tar.bz2 - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/share/phantomjs - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/bin/phantomjs - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/bin/phantomjs - - - // 32 bit ubuntu - cd /usr/local/share - sudo wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.7-linux-i686.tar.bz2 - sudo tar xjf phantomjs-1.9.7-linux-i686.tar.bz2 - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-i686/bin/phantomjs /usr/local/share/phantomjs - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-i686/bin/phantomjs /usr/local/bin/phantomjs - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-i686/bin/phantomjs /usr/bin/phantomjs - - // on either running - phantomjs -v - // will confirm it's installed +now there is a couple other things we are going to need which is nodejs, postgresql, libpq-dev and redis-server sudo apt-get install nodejs @@ -113,7 +91,7 @@ Execute the server: rails s -and dont forget to run the two other servers, for sidekiq, and realtime... +and dont forget to run the other server for realtime... open a new terminal navigate to ./realtime and run @@ -121,11 +99,6 @@ navigate to ./realtime and run npm install nodejs realtime-server.js -open a new terminal -navigate to the main directory and run - - sidekiq - Now you're all set enjoy your personal server of metamaps :) Navigate your browser to localhost:3000 once you have the server running diff --git a/Vagrantfile b/Vagrantfile new file mode 100644 index 00000000..ce873fa4 --- /dev/null +++ b/Vagrantfile @@ -0,0 +1,43 @@ +# -*- mode: ruby -*- +# vi: set ft=ruby : + +$script = <