glenux-contrib/metamaps--metamaps
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Update README.rdoc

Browse source
This commit is contained in:
Connoropolous 2014-04-30 21:09:07 -04:00
parent 53944a9a05
commit 816231234a
1 changed files with 44 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
README.rdoc
View file

@ -1,5 +1,49 @@
==How to code in Metamaps
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
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
git clone git@github.com:Connoropolous/metamaps_gen002.git
cd metamaps_gen002
Now you're in the main directory.
Setting up the database:
1) Copy database.yml.default to database.yml
- Then you'll need to figure out how to configure it to work with Postgresql (which you need to install - try Herokuapp's exe or app)
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'
==Installing on Ubuntu
I had a lot of trouble installing on Ubuntu
I had to install postgresql and libpq-dev. I had to do $rvm reinstall ruby-1.9.3-p125
execjs complained there was no runtime, so I added gem 'therubyracer' to the Gemfile
== The Important Files
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
@ -14,35 +58,6 @@ app/assets/views/*.html.erb: Files in here define either html that is displayed
app/assets/views/*.js.erb: Javascript that is called in response to, e.g., editing or creating a topic, synapse, etc.
Setting up the database:
1) Copy database.yml.default to database.yml
- Then you'll need to figure out how to configure it to work with Postgresql (which you need to install - try Herokuapp's exe or app)
2) In a terminal:
$ rake db:create
$ rake db:schema:load
$ rake db:fixtures:load
Running the server:
$rails s #runs the server
$
$rails c #gives you an interactive console
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'
==Installing on Ubuntu
I had a lot of trouble installing on Ubuntu
I had to install postgresql and libpq-dev. I had to do $rvm reinstall ruby-1.9.3-p125
execjs complained there was no runtime, so I added gem 'therubyracer' to the Gemfile
==License
Metamaps.cc, a visual knowledge communication engine.