Update and rename README.rdoc to README.md
This commit is contained in:
Connor Turland
parent
1ccaccdb32
commit
853c9432d3
2 changed files with 55 additions and 89 deletions
55
README.md
Normal file
55
README.md
Normal file
|
|
@ -0,0 +1,55 @@
|
||||||
|
Metamaps
|
||||||
|
=======
|
||||||
|
|
||||||
|
Welcome to the Metamaps GitHub repo.
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
|
Metamaps is a free and AGPL open source technology for changemakers, innovators, educators and students. It enables individuals and communities to build and visualize their shared knowledge and unlock their collective intelligence. You can find out about more about the project at the [blog][site-blog].
|
||||||
|
|
||||||
|
You can find a version of this software running at [metamaps.cc][site-beta], where the technology is being tested in a private beta.
|
||||||
|
|
||||||
|
Metamaps is created and maintained by a distributed, nomadic community comprised of technologists, artists and storytellers. You can get in touch with us at team@metamaps.cc or @metamapps on twitter.
|
||||||
|
|
||||||
|
To get connected with the community interested in Metamaps, join our [Google+ community][community].
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
- [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
|
||||||
|
|
||||||
|
- If you would like to report a bug, please check the [issues][contributing-issues] section in our [contributing instructions][contributing].
|
||||||
|
- To participate in discussions and a public forum about Metamaps, join the [Google+ community][community]
|
||||||
|
- For contributors, read more instructions in [CONTRIBUTING.md][contributing].
|
||||||
|
|
||||||
|
## Licensing information
|
||||||
|
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
The license can be read [here][license].
|
||||||
|
|
||||||
|
Copyright (c) 2014 Connor Turland
|
||||||
|
|
||||||
|
|
||||||
|
[site-blog]: http://blog.metamaps.cc
|
||||||
|
[site-beta]: http://metamaps.cc
|
||||||
|
[community]: https://plus.google.com/u/0/communities/115060009262157699234
|
||||||
|
[license]: https://github.com/Connoropolous/metamaps_gen002/blob/master/LICENSE
|
||||||
|
[contributing]: https://github.com/Connoropolous/metamaps_gen002/blob/master/CONTRIBUTING.md
|
||||||
|
[contributing-issues]: https://github.com/Connoropolous/metamaps_gen002/blob/master/CONTRIBUTING.md#issues
|
||||||
|
[windows-installation]: https://github.com/Connoropolous/metamaps_gen002/blob/master/WindowsInstallation.md
|
||||||
|
[mac-installation]: https://github.com/Connoropolous/metamaps_gen002/blob/master/MacInstallation.md
|
||||||
|
[ubuntu-installation]: https://github.com/Connoropolous/metamaps_gen002/blob/master/UbuntuInstallation.md
|
||||||
89
README.rdoc
89
README.rdoc
|
|
@ -1,89 +0,0 @@
|
||||||
== Metamaps
|
|
||||||
Metamaps is a free and open source technology for changemakers, innovators, educators and students. It enables individuals and communities to build and visualize their shared knowledge and unlock their collective intelligence. You can find out about more about the project at http://blog.metamaps.cc.
|
|
||||||
|
|
||||||
You can find a version of this software running at http://metamaps.cc, where the technology is being beta tested in a private beta, if you're not up to the task of running your own version.
|
|
||||||
|
|
||||||
Metamaps is created and maintained by a distributed, nomadic community comprised of technologists, artists and storytellers. You can get in touch with us at team@metamaps.cc or @metamapps on twitter.
|
|
||||||
|
|
||||||
To get connected with the community interested in Metamaps, join our G+ community. https://plus.google.com/u/0/communities/115060009262157699234
|
|
||||||
|
|
||||||
To contribute to Metamaps, fork this repository, and submit a pull request!
|
|
||||||
|
|
||||||
==Running Metamaps On Your Local Machine
|
|
||||||
|
|
||||||
First off, Metamaps runs on Ruby On Rails. Ruby 1.9.3 and Rails 3.2. You'll need to get Ruby and Rails installed on your computer if you don't already have it. We recommend using the Rails Installer, which you can download from Mac or Windows at http://railsinstaller.org/en (see the notes below about Ubuntu). This will get you set up perfectly with the right versions of Ruby, and Rails for running your local version of Metamaps.
|
|
||||||
|
|
||||||
It uses postgreSQL 9.2 as a database. You can install that for your computer from here: http://www.enterprisedb.com/products-services-training/pgdownload . During installation you can choose whatever database password you like. Make sure to note it down!
|
|
||||||
|
|
||||||
Once you install those, open a 'command prompt with ruby and rails'.
|
|
||||||
|
|
||||||
Navigate to the folder that you want to download the metamaps files to and run the following: (use your forked git repository address if it's different than this repo. You will also need to go to your Github account settings and add the SSH key that was placed in your clipboard earlier)
|
|
||||||
git clone git@github.com:Connoropolous/metamaps_gen002.git
|
|
||||||
cd metamaps_gen002
|
|
||||||
|
|
||||||
Now you're in the main directory.
|
|
||||||
|
|
||||||
Install all the gems needed for Metamaps by running
|
|
||||||
$ bundle install
|
|
||||||
|
|
||||||
Setting up the database:
|
|
||||||
|
|
||||||
1) Copy /config/database.yml.default and rename the copy to /config/database.yml then edit database.yml with your text editor and set the password to whatever you chose when you set up the PostGres database.
|
|
||||||
|
|
||||||
2) In a terminal:
|
|
||||||
$ rake db:create
|
|
||||||
$ rake db:schema:load
|
|
||||||
$ rake db:fixtures:load
|
|
||||||
|
|
||||||
Running the server:
|
|
||||||
|
|
||||||
$rails s #runs the server
|
|
||||||
|
|
||||||
Navigate your browser to localhost:3000 once you have the server running
|
|
||||||
|
|
||||||
Sign in with the default account
|
|
||||||
|
|
||||||
email: user@user.com
|
|
||||||
|
|
||||||
password: toolsplusconsciousness
|
|
||||||
|
|
||||||
OR create a new account at /users/sign_up, and use access code 'qwertyui'
|
|
||||||
|
|
||||||
Start mapping and programming!
|
|
||||||
|
|
||||||
|
|
||||||
==Installing on Ubuntu
|
|
||||||
|
|
||||||
There can be trouble installing on Ubuntu
|
|
||||||
|
|
||||||
Try installing postgresql and libpq-dev.
|
|
||||||
|
|
||||||
It's also recommended using Ruby Version Manager (rvm)
|
|
||||||
$rvm reinstall ruby-1.9.3-p125
|
|
||||||
|
|
||||||
execjs might complain there is no runtime, if so add gem 'therubyracer' to the Gemfile
|
|
||||||
|
|
||||||
|
|
||||||
== Finding Your Way Around The Code
|
|
||||||
|
|
||||||
Here are the important folders/files:
|
|
||||||
|
|
||||||
config/database.yml: This file is your database configuration. If it doesn't exist, copy it from config/database.yml.default and then get it set up. config/database.yml is in .gitignore
|
|
||||||
|
|
||||||
app/assets/javascripts/application.js: Global Javascript
|
|
||||||
|
|
||||||
app/assets/javascripts/Jit/*: These files handle all code that uses the Javascript Infovis Toolkit, so realistically, most code for laying stuff out is in here.
|
|
||||||
|
|
||||||
app/assets/controllers/*: These files define actions you can do on the different database objects. So for instance, what happens when you edit a Synapse? Check in app/assets/controllers/synapse_controller.rb, in the edit block
|
|
||||||
|
|
||||||
app/assets/views/*.html.erb: Files in here define either html that is displayed when a certain action is called (like edit, or create) on a thing. E.G. app/assets/views/topic/new.html.erb would have a form for creating a new topic. We don't use that way very much anymore though. "Partial" views can be called elsewhere in ruby code and are prefixed with an underscore. So we focus more on the files starting with an underscore. Read through the comments at the top of each file to understand what they all do.
|
|
||||||
|
|
||||||
app/assets/views/*.js.erb: Javascript that is called in response to, e.g., editing or creating a topic, synapse, etc.
|
|
||||||
|
|
||||||
|
|
||||||
== Licensing Information
|
|
||||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses.
|
|
||||||
Loading…
Reference in a new issue