From 767414ad9f9feb8d8d959d5b0407df5fad8bd125 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Tue, 25 Jul 2017 16:37:16 -0700 Subject: [PATCH 01/16] Update MacInstallation.md --- doc/MacInstallation.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/doc/MacInstallation.md b/doc/MacInstallation.md index 50e0bd06..9fdedabe 100644 --- a/doc/MacInstallation.md +++ b/doc/MacInstallation.md @@ -1,21 +1,19 @@ # OSX Install -If you are doing an upgrade and or recent pull for changes you will need to change your default ruby package from 2.1.1 to ruby 2.1.2 - -Some of these steps are pulled from http://www.moncefbelyamani.com/how-to-install-postgresql-on-a-mac-with-homebrew-and-lunchy/ - -Install homebrew +Install rvm (ruby version manager) \curl -sSL https://get.rvm.io | bash -s stable --rails + +Use rvm to install Ruby version 2.3.0 + rvm install 2.3.0 --with-gcc=clang rvm use 2.3.0 - gem install lunchy -Now install homebrew. +Now install homebrew. (a package manager for mac) ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" -Then install nodejs and ES6 code +Then install nodejs (make sure its version 6.11.1 or greater) brew install nodejs npm install @@ -29,7 +27,7 @@ And postgresql: Set a password, then start the service: - lunchy start postgres + brew services start postgresql Change directory to the metamaps git repository, and run: @@ -43,3 +41,8 @@ Copy the .example-env file and rename it to .env. Then modify the DB_USERNAME an rails server Now open a browser to http://localhost:3000! + +To start the realtime server: + + cd realtime + node realtime-server.js From dc4d44951ed5a1746d68da45644341cd66f02031 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Tue, 25 Jul 2017 16:41:47 -0700 Subject: [PATCH 02/16] Update UbuntuInstallation.md --- doc/UbuntuInstallation.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/doc/UbuntuInstallation.md b/doc/UbuntuInstallation.md index bc100fdb..427a525f 100644 --- a/doc/UbuntuInstallation.md +++ b/doc/UbuntuInstallation.md @@ -89,9 +89,7 @@ server: and dont forget to run the other server for realtime... - cd realtime - npm install - node realtime-server.js + node realtime/realtime-server.js Now you're all set enjoy your personal server of metamaps :) Navigate your browser to localhost:3000 once you have the server running. Sign in with the default account From 9d590295cb0711fa62403e96dbf1e2cb200d65d4 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Tue, 25 Jul 2017 16:44:40 -0700 Subject: [PATCH 03/16] Update WindowsInstallation.md --- doc/WindowsInstallation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/WindowsInstallation.md b/doc/WindowsInstallation.md index 2aed29fa..77df2d57 100644 --- a/doc/WindowsInstallation.md +++ b/doc/WindowsInstallation.md @@ -1,3 +1,5 @@ +DISCLAIMER: This tutorial is liable to be out of date, and we don't necessarily support windows development. If you are set on installing Metamaps on windows, it may be worthwhile to look at the Mac and Ubuntu docs for up to date information on what metamaps requires to run. + Before you begin, you'll need to install stuff: Ruby, Git, and Rails: http://railsinstaller.org/en From 271fc7ebd03d39da2a3a93f1aff4391a82031ae7 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Tue, 25 Jul 2017 16:47:33 -0700 Subject: [PATCH 04/16] Update MacInstallation.md --- doc/MacInstallation.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/doc/MacInstallation.md b/doc/MacInstallation.md index 9fdedabe..296918c7 100644 --- a/doc/MacInstallation.md +++ b/doc/MacInstallation.md @@ -39,10 +39,23 @@ Copy the .example-env file and rename it to .env. Then modify the DB_USERNAME an rake db:schema:load rake db:seed rails server - -Now open a browser to http://localhost:3000! - + To start the realtime server: - cd realtime - node realtime-server.js + node realtime/realtime-server.js + +NOTE: if you want to actively develop on the javascript in `/frontend` use + + npm run build:watch +to start a webpack build process that updates the build everytime you make code changes + +Now open a browser to http://localhost:3000! + +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! From d08cb3f95ef6ed5b611ee21923014fa83909da88 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Tue, 25 Jul 2017 16:52:11 -0700 Subject: [PATCH 05/16] Update UbuntuInstallation.md --- doc/UbuntuInstallation.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/UbuntuInstallation.md b/doc/UbuntuInstallation.md index 427a525f..784239ab 100644 --- a/doc/UbuntuInstallation.md +++ b/doc/UbuntuInstallation.md @@ -86,10 +86,15 @@ Open a new terminal, navigate to the metamaps directory, and execute the server: rails s + +NOTE: if you want to actively develop on the javascript in /frontend use + + npm run build:watch and dont forget to run the other server for realtime... - node realtime/realtime-server.js + node realtime/realtime-server.js +to start a webpack build process that updates the build everytime you make code changes Now you're all set enjoy your personal server of metamaps :) Navigate your browser to localhost:3000 once you have the server running. Sign in with the default account From 785e16eeae941e563ca1027a19ab70f7fabcf2b0 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Tue, 25 Jul 2017 16:57:37 -0700 Subject: [PATCH 06/16] make Vagrantfile realtime server port match default --- Vagrantfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Vagrantfile b/Vagrantfile index 6ee6cb35..de1c6dde 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -37,7 +37,7 @@ Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| config.vm.box = 'trusty64' config.vm.box_url = 'http://cloud-images.ubuntu.com/vagrant/trusty/current/trusty-server-cloudimg-amd64-vagrant-disk1.box' config.vm.network :forwarded_port, guest: 3000, host: 3000 - config.vm.network :forwarded_port, guest: 5001, host: 5001 + config.vm.network :forwarded_port, guest: 5000, host: 5000 config.vm.network 'private_network', ip: '10.0.1.11' config.vm.synced_folder '.', '/vagrant', nfs: true From 1af47280733f2cf48c271fada9cdd643b20fe3e8 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Tue, 25 Jul 2017 17:06:27 -0700 Subject: [PATCH 07/16] Update UbuntuInstallation.md --- doc/UbuntuInstallation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/UbuntuInstallation.md b/doc/UbuntuInstallation.md index 784239ab..72de7618 100644 --- a/doc/UbuntuInstallation.md +++ b/doc/UbuntuInstallation.md @@ -80,6 +80,7 @@ Use these commands to set the password to 3112 and then quit: now we can use rake to create, load the schema into, and load db/seeds.rb into the postgres database: + rake db:create rake db:setup Open a new terminal, navigate to the metamaps directory, and execute the From 1ec9dc20e4f4cebc1fc6a638c3e75c806c7b9da0 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Tue, 25 Jul 2017 17:07:46 -0700 Subject: [PATCH 08/16] Update MacInstallation.md --- doc/MacInstallation.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/MacInstallation.md b/doc/MacInstallation.md index 296918c7..44f67ad9 100644 --- a/doc/MacInstallation.md +++ b/doc/MacInstallation.md @@ -35,9 +35,13 @@ Change directory to the metamaps git repository, and run: Copy the .example-env file and rename it to .env. Then modify the DB_USERNAME and DB_PASSWORD values to match the postgres username and password you set +Now use rake to create and set up the database + rake db:create - rake db:schema:load - rake db:seed + rake db:setup + +To start the rails server: + rails server To start the realtime server: From 3203c2b4d0b6717b3db6ad968b067c1016993247 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Tue, 25 Jul 2017 17:18:07 -0700 Subject: [PATCH 09/16] de-prioritize vagrant docs, as its no longer our setup of choice --- README.md | 46 ++++++++++++---------------------------------- 1 file changed, 12 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 5bb17272..694180f3 100644 --- a/README.md +++ b/README.md @@ -28,44 +28,19 @@ Metamaps is developed and maintained by a distributed, nomadic community compris - If you would like to report a bug, please check the [issues][contributing-issues] section in our [contributing instructions][contributing]. - If you would like to get set up as a developer, that's great! Read on for help getting your development environment set up. -## Installation +## Installation for local use or development of Metamaps -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! -``` -There are two options for cloning the repository - the simplest way is the first one since you don't need to set up SSH keys: -git clone https://github.com/metamaps/metamaps +First off is getting the code downloaded to your computer. You can download a zip file from github, but if you've got `git` you can just run `git clone https://github.com/metamaps/metamaps` in your terminal. -OR +There are instructions for setup on various platforms, with particular support for Mac and Ubuntu, which can be found here: +[Mac Install Walkthrough][mac-installation] +[Ubuntu Install Walkthrough][ubuntu-installation] -git clone git@github.com:metamaps/metamaps.git -``` -Now ensure you have VirtualBox and Vagrant installed on your computer -``` -cd metamaps -./bin/configure.sh -``` -This will do all the setup steps to make Metamaps work with a bit of behind the scenes ninja magick. +If you don't want to take all those steps manually, and you'd prefer a simpler setup by using Vagrant, you can do that too: +[Vagrant installation][vagrant-installation] -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! - -We haven't set up instructions for using Vagrant on Windows, but there are instructions for a manual setup here: - -- [For Windows][windows-installation] +We don't promise support for windows, but at one point we had it running and we've kept those docs available for reference +[Windows][windows-installation] ## Licensing information @@ -81,4 +56,7 @@ Copyright (c) 2017 Connor Turland [license]: https://github.com/metamaps/metamaps/blob/develop/LICENSE [contributing]: https://github.com/metamaps/metamaps/blob/develop/doc/CONTRIBUTING.md [contributing-issues]: https://github.com/metamaps/metamaps/blob/develop/doc/CONTRIBUTING.md#reporting-bugs-and-other-issues +[mac-installation]: https://github.com/metamaps/metamaps/blob/develop/doc/MacInstallation.md +[ubuntu-installation]: https://github.com/metamaps/metamaps/blob/develop/doc/UbuntuInstallation.md +[vagrant-installation]: https://github.com/metamaps/metamaps/blob/develop/doc/VagrantInstallation.md [windows-installation]: https://github.com/metamaps/metamaps/blob/develop/doc/WindowsInstallation.md From 4e7bf027494caa9c54e86c4266e65272741cdd5d Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Tue, 25 Jul 2017 17:19:17 -0700 Subject: [PATCH 10/16] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 694180f3..9002587f 100644 --- a/README.md +++ b/README.md @@ -33,14 +33,14 @@ Metamaps is developed and maintained by a distributed, nomadic community compris First off is getting the code downloaded to your computer. You can download a zip file from github, but if you've got `git` you can just run `git clone https://github.com/metamaps/metamaps` in your terminal. There are instructions for setup on various platforms, with particular support for Mac and Ubuntu, which can be found here: -[Mac Install Walkthrough][mac-installation] -[Ubuntu Install Walkthrough][ubuntu-installation] +- [Mac Install Walkthrough][mac-installation] +- [Ubuntu Install Walkthrough][ubuntu-installation] If you don't want to take all those steps manually, and you'd prefer a simpler setup by using Vagrant, you can do that too: -[Vagrant installation][vagrant-installation] +- [Vagrant installation][vagrant-installation] We don't promise support for windows, but at one point we had it running and we've kept those docs available for reference -[Windows][windows-installation] +- [Outdated Windows Walkthrough][windows-installation] ## Licensing information From c2cb8949ebe46714ffc001b89740ef9781395e1a Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Tue, 25 Jul 2017 17:22:27 -0700 Subject: [PATCH 11/16] Create VagrantInstallation.md --- doc/VagrantInstallation.md | 45 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 doc/VagrantInstallation.md diff --git a/doc/VagrantInstallation.md b/doc/VagrantInstallation.md new file mode 100644 index 00000000..294ec76e --- /dev/null +++ b/doc/VagrantInstallation.md @@ -0,0 +1,45 @@ +Now ensure you have VirtualBox and Vagrant installed on your computer + +``` + +cd metamaps + +./bin/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! From 12fc0c71f6cc806ec3b03288190cb0f13cf4563b Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Wed, 26 Jul 2017 09:21:16 -0700 Subject: [PATCH 12/16] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9002587f..483909b3 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,10 @@ There are instructions for setup on various platforms, with particular support f - [Mac Install Walkthrough][mac-installation] - [Ubuntu Install Walkthrough][ubuntu-installation] -If you don't want to take all those steps manually, and you'd prefer a simpler setup by using Vagrant, you can do that too: +If you prefer to isolate your install in a virtual machine, you may find it simpler to setup using Vagrant: - [Vagrant installation][vagrant-installation] -We don't promise support for windows, but at one point we had it running and we've kept those docs available for reference +We don't promise support for Windows, but at one point we had it running and we've kept those docs available for reference - [Outdated Windows Walkthrough][windows-installation] ## Licensing information From 9783a5ee1eddfeb8654bc769c923b7cf33cd7d4f Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Wed, 26 Jul 2017 09:22:06 -0700 Subject: [PATCH 13/16] Update MacInstallation.md --- doc/MacInstallation.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/MacInstallation.md b/doc/MacInstallation.md index 44f67ad9..d89d2153 100644 --- a/doc/MacInstallation.md +++ b/doc/MacInstallation.md @@ -38,7 +38,8 @@ Copy the .example-env file and rename it to .env. Then modify the DB_USERNAME an Now use rake to create and set up the database rake db:create - rake db:setup + rake db:schema:load + rake db:seed To start the rails server: From 3829d32390b3b950c5599a190157e08744ee7702 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Wed, 26 Jul 2017 09:22:34 -0700 Subject: [PATCH 14/16] Update UbuntuInstallation.md --- doc/UbuntuInstallation.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/UbuntuInstallation.md b/doc/UbuntuInstallation.md index 72de7618..03314074 100644 --- a/doc/UbuntuInstallation.md +++ b/doc/UbuntuInstallation.md @@ -81,7 +81,8 @@ now we can use rake to create, load the schema into, and load db/seeds.rb into the postgres database: rake db:create - rake db:setup + rake db:schema:load + rake db:seed Open a new terminal, navigate to the metamaps directory, and execute the server: From bb546779cddbd1ced5f2ef5188550eed9e410a11 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Wed, 26 Jul 2017 09:24:51 -0700 Subject: [PATCH 15/16] Update VagrantInstallation.md --- doc/VagrantInstallation.md | 18 +----------------- 1 file changed, 1 insertion(+), 17 deletions(-) diff --git a/doc/VagrantInstallation.md b/doc/VagrantInstallation.md index 294ec76e..ad4cfce2 100644 --- a/doc/VagrantInstallation.md +++ b/doc/VagrantInstallation.md @@ -1,37 +1,23 @@ Now ensure you have VirtualBox and Vagrant installed on your computer - ``` - cd metamaps - ./bin/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: - +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` @@ -40,6 +26,4 @@ password: `toolsplusconsciousness` OR create a new account at `/join`, and use access code `qwertyui` - - Start mapping and programming! From e016b923a4afa2a27aa02cfbf130c3bb6cdde944 Mon Sep 17 00:00:00 2001 From: Connor Turland Date: Wed, 26 Jul 2017 09:25:41 -0700 Subject: [PATCH 16/16] Update WindowsInstallation.md --- doc/WindowsInstallation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/WindowsInstallation.md b/doc/WindowsInstallation.md index 77df2d57..d2049f73 100644 --- a/doc/WindowsInstallation.md +++ b/doc/WindowsInstallation.md @@ -1,4 +1,4 @@ -DISCLAIMER: This tutorial is liable to be out of date, and we don't necessarily support windows development. If you are set on installing Metamaps on windows, it may be worthwhile to look at the Mac and Ubuntu docs for up to date information on what metamaps requires to run. +DISCLAIMER: This tutorial is liable to be out of date, and we don't necessarily support Windows development. If you are set on installing Metamaps on Windows, it may be worthwhile to look at the Mac and Ubuntu docs for up to date information on what Metamaps requires to run. Before you begin, you'll need to install stuff: @@ -41,7 +41,7 @@ fail unless `.env` is correctly configured and Postgres is running. rake db:create rake db:schema:load - rake db:fixtures:load + rake db:seed And you're set up! At this point, you should be able to run the server at any time with only one command; you don't need to repeat any of the previous steps