commit
0a9a1c27d8
9 changed files with 33 additions and 33 deletions
16
README.md
16
README.md
|
@ -1,8 +1,8 @@
|
||||||
Metamaps
|
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)
|
[![Join the chat at https://gitter.im/metamaps/metamaps](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/metamaps/metamaps?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||||
[![Build Status](https://travis-ci.org/metamaps/metamaps_gen002.svg)](https://travis-ci.org/metamaps/metamaps_gen002)
|
[![Build Status](https://travis-ci.org/metamaps/metamaps.svg)](https://travis-ci.org/metamaps/metamaps)
|
||||||
|
|
||||||
Welcome to the Metamaps GitHub repo.
|
Welcome to the Metamaps GitHub repo.
|
||||||
|
|
||||||
|
@ -20,11 +20,11 @@ To get connected with the community interested in Metamaps, join our [Google+ co
|
||||||
|
|
||||||
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!
|
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
|
git clone git@github.com:metamaps/metamaps.git
|
||||||
```
|
```
|
||||||
Now ensure you have VirtualBox and Vagrant installed on your computer
|
Now ensure you have VirtualBox and Vagrant installed on your computer
|
||||||
```
|
```
|
||||||
cd metamaps_gen002
|
cd metamaps
|
||||||
./bin/configure.sh
|
./bin/configure.sh
|
||||||
```
|
```
|
||||||
This will do all the setup steps to make Metamaps work with a bit of behind the scenes ninja magick.
|
This will do all the setup steps to make Metamaps work with a bit of behind the scenes ninja magick.
|
||||||
|
@ -73,7 +73,7 @@ Copyright (c) 2015 Connor Turland
|
||||||
[site-blog]: http://blog.metamaps.cc
|
[site-blog]: http://blog.metamaps.cc
|
||||||
[site-beta]: http://metamaps.cc
|
[site-beta]: http://metamaps.cc
|
||||||
[community]: https://plus.google.com/u/0/communities/115060009262157699234
|
[community]: https://plus.google.com/u/0/communities/115060009262157699234
|
||||||
[license]: https://github.com/metamaps/metamaps_gen002/blob/develop/LICENSE
|
[license]: https://github.com/metamaps/metamaps/blob/develop/LICENSE
|
||||||
[contributing]: https://github.com/metamaps/metamaps_gen002/blob/develop/doc/CONTRIBUTING.md
|
[contributing]: https://github.com/metamaps/metamaps/blob/develop/doc/CONTRIBUTING.md
|
||||||
[contributing-issues]: https://github.com/metamaps/metamaps_gen002/blob/develop/doc/CONTRIBUTING.md#reporting-bugs-and-other-issues
|
[contributing-issues]: https://github.com/metamaps/metamaps/blob/develop/doc/CONTRIBUTING.md#reporting-bugs-and-other-issues
|
||||||
[windows-installation]: https://github.com/metamaps/metamaps_gen002/blob/develop/doc/WindowsInstallation.md
|
[windows-installation]: https://github.com/metamaps/metamaps/blob/develop/doc/WindowsInstallation.md
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
Metamaps.cc is an open source project, and we are always looking for new
|
Metamaps.cc is an open source project, and we are always looking for new
|
||||||
developers to help contribute to our codebase! To get involved, send an
|
developers to help contribute to our codebase! To get involved, send an
|
||||||
email to team@metamaps.cc or find us on Github at
|
email to team@metamaps.cc or find us on Github at
|
||||||
https://github.com/metamaps/metamaps_gen002.
|
https://github.com/metamaps/metamaps.
|
||||||
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
|
|
@ -51,7 +51,7 @@
|
||||||
</a>
|
</a>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a id="lightbox_source" href="https://github.com/metamaps/metamaps_gen002" target="_blank">
|
<a id="lightbox_source" href="https://github.com/metamaps/metamaps" target="_blank">
|
||||||
<div class="lightboxAboutIcon"></div>
|
<div class="lightboxAboutIcon"></div>
|
||||||
source code
|
source code
|
||||||
</a>
|
</a>
|
||||||
|
@ -205,7 +205,7 @@
|
||||||
|
|
||||||
<p><b>MEMBERS</b> are contributors who act as stewards and guardians of the collective and are responsible for maintaining our culture and purpose. We're working on a set of agreements to formalize what it means to be a member.</p>
|
<p><b>MEMBERS</b> are contributors who act as stewards and guardians of the collective and are responsible for maintaining our culture and purpose. We're working on a set of agreements to formalize what it means to be a member.</p>
|
||||||
|
|
||||||
<p>We welcome people of all skillsets to create value within our network. There's open possibilities for designers, researchers, academics, strategists, and facilitators to contribute. If you're a developer, help us advance the code and take a look around our <a href="https://github.com/metamaps/metamaps_gen002" target="_blank">Github</a>.</p>
|
<p>We welcome people of all skillsets to create value within our network. There's open possibilities for designers, researchers, academics, strategists, and facilitators to contribute. If you're a developer, help us advance the code and take a look around our <a href="https://github.com/metamaps/metamaps" target="_blank">Github</a>.</p>
|
||||||
|
|
||||||
<p>Thanks for your interest in helping out with Metamaps! Hopefully this gets you pointed in the right direction to get involved. The next step is to read the links on this page and then contribute! </p>
|
<p>Thanks for your interest in helping out with Metamaps! Hopefully this gets you pointed in the right direction to get involved. The next step is to read the links on this page and then contribute! </p>
|
||||||
|
|
||||||
|
|
|
@ -34,7 +34,7 @@
|
||||||
</div><!-- end yield -->
|
</div><!-- end yield -->
|
||||||
<div class="github-fork-ribbon-wrapper right-bottom">
|
<div class="github-fork-ribbon-wrapper right-bottom">
|
||||||
<div class="github-fork-ribbon">
|
<div class="github-fork-ribbon">
|
||||||
<a href="https://github.com/metamaps/metamaps_gen002" target="_blank">Fork me on GitHub</a>
|
<a href="https://github.com/metamaps/metamaps" target="_blank">Fork me on GitHub</a>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<script>
|
<script>
|
||||||
|
|
|
@ -90,7 +90,7 @@ If you'd like to contribute a fix for a bug you've encountered, first read up on
|
||||||
aware of the issue. By filing the issue first, we may be able to provide you
|
aware of the issue. By filing the issue first, we may be able to provide you
|
||||||
with some insight that guides you in the right direction.
|
with some insight that guides you in the right direction.
|
||||||
|
|
||||||
[metamaps-issues]: https://github.com/metamaps/metamaps_gen002/labels/bug
|
[metamaps-issues]: https://github.com/metamaps/metamaps/labels/bug
|
||||||
[git-branching-model]: http://nvie.com/posts/a-successful-git-branching-model/
|
[git-branching-model]: http://nvie.com/posts/a-successful-git-branching-model/
|
||||||
[fork-metamaps]: https://github.com/metamaps/metamaps_gen002/fork
|
[fork-metamaps]: https://github.com/metamaps/metamaps/fork
|
||||||
[cla]: http://metamaps.cc/cla
|
[cla]: http://metamaps.cc/cla
|
||||||
|
|
|
@ -30,7 +30,7 @@ Within the app/ folder, you can find these important folders:
|
||||||
|
|
||||||
The lifecycle works something like this.
|
The lifecycle works something like this.
|
||||||
|
|
||||||
1. run `rake routes` inside the metamaps_gen002 directory on your computer, and it will generate a list with entries looking something like `GET /maps/:id maps#show`. This tells you which URL will end up at which *controller*. In this example, if you accessed `https://metamaps.cc/maps/2`, you are looking for the maps_controller's `show` function, and there will be a variable params["id"] that is equal to 2.
|
1. run `rake routes` inside the metamaps directory on your computer, and it will generate a list with entries looking something like `GET /maps/:id maps#show`. This tells you which URL will end up at which *controller*. In this example, if you accessed `https://metamaps.cc/maps/2`, you are looking for the maps_controller's `show` function, and there will be a variable params["id"] that is equal to 2.
|
||||||
2. Now in `app/controllers/maps_controller.rb`, you can find the function. It should do some calculations, create an instance variable @map, and then do one of two things:
|
2. Now in `app/controllers/maps_controller.rb`, you can find the function. It should do some calculations, create an instance variable @map, and then do one of two things:
|
||||||
- If it doesn't call anything, ruby on rails will automatically load app/views/map/show.html.erb. (NB: If you loaded `/maps/2.json`, it would look for app/views/map/show.json.erb). Any instance variables assigned (e.g. @map) will be available to the view file (show.html.erb).
|
- If it doesn't call anything, ruby on rails will automatically load app/views/map/show.html.erb. (NB: If you loaded `/maps/2.json`, it would look for app/views/map/show.json.erb). Any instance variables assigned (e.g. @map) will be available to the view file (show.html.erb).
|
||||||
- You can also call the render function directly. See the codebase or http://guides.rubyonrails.org/layouts_and_rendering.html#using-render for details.
|
- You can also call the render function directly. See the codebase or http://guides.rubyonrails.org/layouts_and_rendering.html#using-render for details.
|
||||||
|
|
|
@ -32,7 +32,7 @@ Running this will check your system for requirements as well so you will need to
|
||||||
|
|
||||||
All right now we can download metamaps from the master using git
|
All right now we can download metamaps from the master using git
|
||||||
|
|
||||||
git clone https://github.com/metamaps/metamaps_gen002.git
|
git clone https://github.com/metamaps/metamaps.git
|
||||||
|
|
||||||
Now there is a couple other things we are going to need which is nodejs, postgresql, libpq-dev and redis-server
|
Now there is a couple other things we are going to need which is nodejs, postgresql, libpq-dev and redis-server
|
||||||
|
|
||||||
|
@ -48,14 +48,14 @@ ImageMagick in the Ubuntu Software Centre
|
||||||
|
|
||||||
Install the specific version of ruby needed this will take some time
|
Install the specific version of ruby needed this will take some time
|
||||||
|
|
||||||
rvm install $(cat metamaps_gen002/.ruby-version)
|
rvm install $(cat metamaps/.ruby-version)
|
||||||
|
|
||||||
Now we also need to copy .example-env to a new file named .env. Review the
|
Now we also need to copy .example-env to a new file named .env. Review the
|
||||||
configuration in here to see if you need any changes.
|
configuration in here to see if you need any changes.
|
||||||
|
|
||||||
cp .example-env .env
|
cp .example-env .env
|
||||||
|
|
||||||
Now run inside your metamaps_gen002 folder:
|
Now run inside your metamaps folder:
|
||||||
|
|
||||||
gem install bundle
|
gem install bundle
|
||||||
bundle install
|
bundle install
|
||||||
|
|
|
@ -13,16 +13,16 @@ folder writable by your user account.
|
||||||
|
|
||||||
Now you are ready to clone the Metamaps git repository:
|
Now you are ready to clone the Metamaps git repository:
|
||||||
|
|
||||||
git clone https://github.com/metamaps/metamaps_gen002.git --branch develop
|
git clone https://github.com/metamaps/metamaps.git --branch develop
|
||||||
cd metamaps_gen002
|
cd metamaps
|
||||||
bundle install
|
bundle install
|
||||||
|
|
||||||
The third `bundle install` command downloads and installs the rubygem
|
The third `bundle install` command downloads and installs the rubygem
|
||||||
dependencies of Metamaps.
|
dependencies of Metamaps.
|
||||||
|
|
||||||
At this point you should be in C:\git\metamaps_gen002, or whatever equivalent
|
At this point you should be in C:\git\metamaps, or whatever equivalent
|
||||||
directory you've chosen. The next step is to set up your database
|
directory you've chosen. The next step is to set up your database
|
||||||
configuration. From the metamaps_gen002 directory, run
|
configuration. From the metamaps directory, run
|
||||||
|
|
||||||
start config
|
start config
|
||||||
|
|
||||||
|
|
|
@ -36,16 +36,16 @@
|
||||||
|
|
||||||
sudo su - metamaps
|
sudo su - metamaps
|
||||||
rvm user gemsets
|
rvm user gemsets
|
||||||
git clone https://github.com/metamaps/metamaps_gen002 \
|
git clone https://github.com/metamaps/metamaps \
|
||||||
--branch instance/mycoolinstance
|
--branch instance/mycoolinstance
|
||||||
rvm install $(cat metamaps_gen002/.ruby-version) #ensure ruby is installed
|
rvm install $(cat metamaps/.ruby-version) #ensure ruby is installed
|
||||||
cd metamaps_gen002
|
cd metamaps
|
||||||
gem install bundle
|
gem install bundle
|
||||||
bundle install
|
bundle install
|
||||||
|
|
||||||
#### Connect rails database
|
#### Connect rails database
|
||||||
|
|
||||||
Run this in the metamaps_gen002 directory, still as metamaps:
|
Run this in the metamaps directory, still as metamaps:
|
||||||
|
|
||||||
cp .example-env .env
|
cp .example-env .env
|
||||||
nano .env # fill in DB_* values, and realtime server at least. Ctrl+X to save/exit.
|
nano .env # fill in DB_* values, and realtime server at least. Ctrl+X to save/exit.
|
||||||
|
@ -59,7 +59,7 @@ Get an SSL certificate and encrypt it for the realtime video.
|
||||||
|
|
||||||
#### And finally
|
#### And finally
|
||||||
|
|
||||||
passenger-config restart-app /home/metamaps/metamaps_gen002
|
passenger-config restart-app /home/metamaps/metamaps
|
||||||
|
|
||||||
If this command fails, it may be helpful for debugging to run a test server to
|
If this command fails, it may be helpful for debugging to run a test server to
|
||||||
see what problems show up:
|
see what problems show up:
|
||||||
|
@ -71,13 +71,13 @@ see what problems show up:
|
||||||
sudo aptitude install nodejs npm
|
sudo aptitude install nodejs npm
|
||||||
sudo ln -s /usr/bin/nodejs /usr/bin/node
|
sudo ln -s /usr/bin/nodejs /usr/bin/node
|
||||||
sudo npm install -g forever
|
sudo npm install -g forever
|
||||||
(crontab -u metamaps -l 2>/dev/null; echo "@reboot $(which forever) --append -l /home/metamaps/logs/forever.realtime.log start /home/metamaps/metamaps_gen002/realtime/realtime-server.js") | crontab -u metamaps -
|
(crontab -u metamaps -l 2>/dev/null; echo "@reboot $(which forever) --append -l /home/metamaps/logs/forever.realtime.log start /home/metamaps/metamaps/realtime/realtime-server.js") | crontab -u metamaps -
|
||||||
|
|
||||||
cd /home/metamaps/metamaps_gen002/realtime
|
cd /home/metamaps/metamaps/realtime
|
||||||
npm install
|
npm install
|
||||||
mkdir -p /home/metamaps/logs
|
mkdir -p /home/metamaps/logs
|
||||||
forever --append -l /home/metamaps/logs/forever.realtime.log \
|
forever --append -l /home/metamaps/logs/forever.realtime.log \
|
||||||
start /home/metamaps/metamaps_gen002/realtime/realtime-server.js
|
start /home/metamaps/metamaps/realtime/realtime-server.js
|
||||||
|
|
||||||
#### Upstart service for delayed_worker:
|
#### Upstart service for delayed_worker:
|
||||||
|
|
||||||
|
@ -90,11 +90,11 @@ Put the following code into `/etc/init/metamaps_delayed_worker.conf`:
|
||||||
|
|
||||||
setuid metamaps
|
setuid metamaps
|
||||||
setgid metamaps
|
setgid metamaps
|
||||||
chdir /home/metamaps/metamaps_gen002
|
chdir /home/metamaps/metamaps
|
||||||
|
|
||||||
env HOME=/home/metamaps
|
env HOME=/home/metamaps
|
||||||
env PATH="/usr/local/rvm/gems/ruby-2.1.3@metamaps_gen002/bin:/usr/local/rvm/gems/ruby-2.1.3@global/bin:/usr/local/rvm/rubies/ruby-2.1.3/bin:/usr/local/rvm/bin:/usr/local/bin:/usr/bin:/bin"
|
env PATH="/usr/local/rvm/gems/ruby-2.1.3@metamaps/bin:/usr/local/rvm/gems/ruby-2.1.3@global/bin:/usr/local/rvm/rubies/ruby-2.1.3/bin:/usr/local/rvm/bin:/usr/local/bin:/usr/bin:/bin"
|
||||||
env GEM_PATH="/usr/local/rvm/gems/ruby-2.1.3@metamaps_gen002:/usr/local/rvm/gems/ruby-2.1.3@global"
|
env GEM_PATH="/usr/local/rvm/gems/ruby-2.1.3@metamaps:/usr/local/rvm/gems/ruby-2.1.3@global"
|
||||||
env RAILS_ENV="production"
|
env RAILS_ENV="production"
|
||||||
|
|
||||||
respawn
|
respawn
|
||||||
|
|
Loading…
Reference in a new issue