-
Notifications
You must be signed in to change notification settings - Fork 0
InstallationGnuLinux
Issue the following command on a terminal. You need to be root or use "sudo" (the Ubuntu way) to do that. Both methods are correct. Use only one of the following methods :
(as root):
$> su # and then enter your root password #> aptitude install ruby-full build-essential rubygems rake libsvn-ruby subversion
(as normal user, with the "sudo" method):
$> sudo aptitude install ruby-full build-essential rubygems rake libsvn-ruby subversion # and then enter your root password
Note : You can either use PostgreSQL or MySQL or SQLite3 as database
SQLite3 is easier to install, but should only used in development, not in production. You may also experience database conflicts, in particular if you want to test PDF Conversion. In case of PDF Conversion, you MUST use PostgreSQL or MySQL
Once you have decided what database best suits you :
- Setting up the Database (SQLite)
- Setting up the Database (MySQL)
- Setting up the Database (PostgreSQL)
This section assumes, you have gem version >= 1.3.6 (required for rails version > 2.3.7).
Note that ruby-postgres is unmaintained and does not compile against postgresql-8.3+. Therefore, do not install it. Instead, install ruby-pg which works just fine. So, the list of gems required for MarkUs is as follows:
- rails
- rake
- mongrel
- ruby-pg
- postgres
- fastercsv
- ruby-debug
- shoulda
- machinist
- factory_data_preloader
- faker
- will_paginate
- rubyzip
- ya2yaml
We are now using bundler to manage all gems. Install only bundler as a gem and bundler will install all other Gems.
To install the all gems execute the following:
#> gem install bundler #> bundle install
Bundle allows also some selective installation. To install only sqlite3 supportr, execute the following:
#> bundle install --without postgresql mysql
On Ubuntu and Debian systems, the system can't find bundler. You need to add bundler to your PATH or run it directly
#>/var/lib/gems/1.8/bin/bundle
If you get a message saying "Missing these required gems", then it is likely
that some new gems have been integrated into Markus development and also need
to be installed using bundle install as described above.
Now, check that everything worked fine. Do the following on a terminal (as an ordinary user, not root):
#> irb irb(main):001:0> require 'rubygems' => true irb(main):002:0> require 'postgres' => true irb(main):003:0> require 'fastercsv' => true irb(main):003:0> require 'ruby-debug' => true
The "true" output indicates that everything went fine and you are ready to go to the next step. Also, <code>rake --version</code> should report a version >= 0.8.7 and <code>rails --version</code> should report a rails version >= 2.2.x
You can also run the following to check your gems:
#> gem list --local *** LOCAL GEMS *** actionmailer (2.3.5) actionpack (2.3.5) activerecord (2.3.5) activeresource (2.3.5) activesupport (2.3.5) columnize (0.3.1) fastercsv (1.5.0) linecache (0.43) mongrel (1.1.5) postgres (0.7.9.2008.01.28) rack (1.1.0, 1.0.1) rails (2.3.5) rake (0.8.7) ruby-debug (0.10.3) ruby-debug-base (0.10.3) ruby-debug-ide (0.4.9, 0.4.5) ruby-pg (0.7.9.2008.01.28) selenium-client (1.2.18) shoulda (2.10.2) thoughtbot-shoulda (2.10.2) will_paginate (2.3.11) rubyzip (1.3.6)
Precondition: You have the MarkUs source-code checked out and do not plan to use RadRails (see the following sections if you _plan_ to use RadRails for development).
MarkUs is configured by editing config/environment.rb (If you have a rails version > 2.3.2 comment out the line containing RAILS_GEM_ENV; minimum rails version is 2.2.x). Read through all settings in environment.rb
Look at config/environments/development.rb
-
Change the REPOSITORY_STORAGE path to an appropriate path for your setup.
-
if you see: #config.gem 'thoughtbot-shoulda' then changed it to config.gem 'thoughtbot-shoulda'
- since we use thoughtbot-shoulda as a testing framework (it builds on top of Test::Unit and is fully backwards compatible) and install it as directed when you run 'rake' the next time.
Setup the database.yml file:
- cp config/database.yml.sample config/database.yml (replace sample by the database you use (PostgreSQL, SQLite3 or MySQl)
- change the usernames and password to olm_db_admin
If you followed the above installation instructions in order, you should have a working MarkUs installation (in terms of required software and required configuration). But first you would need to create the development database, load relations into it and populate the db with some data. You can do so by the following series of commands (as non-root user, assuming you are in the application-root of the MarkUs source code;)(please adapt the following command):
# gets gems that you do not have yet, like thoughtbot-shoulda #> bundle install --without (postgresql) (sqlite) (mysql) #> rake db:create # creates development database #> rake db:schema:load # loads required relations into database #> rake db:populate # populates database with some data #> rake db:test:prepare #> rake test:units #> rake test:functionals
Note: there are still tests that are failing.
Now, you are ready to test your plain MarkUs installation. The most straight forward way to do this is to start the mongrel server on the command-line. You can do so by:
script/server #boots up mongrel (or WebRink, if mongrel is not installed/found)
Common Problems
If some of the previous commands fail with error message similar to
LoadError: no such file to load -- \<some-ruby-gem\>, try to install the
missing Ruby gem by issuing gem install \<missing-ruby-gem\> and retry the
step which failed.
If everything above went fine: Congratulations! You have a working MarkUs installation. Go to http://0.0.0.0:3000/ and enjoy MarkUs!
However, since you are a MarkUs developer, this is only _half_ of the game. You also need (yes, this is not optional!) _some_ sort of IDE for MarkUs development. For instance, the next section describes how to install RadRails IDE, an Eclipse based Rails development environment. If you plan to use something _else_ for MarkUs development, such as JEdit (with some tweaks) or VIM, you should now start configuring them.
But if you _do_ plan to use RadRails for development, you should get rid of some left-overs from previous steps, so that the following instructions run as smoothly as possible for you. This is what you'd need to do (If you know what you are doing, you might find this silly. But this guide tries to give detailed instructions for Rails newcomers):
#> rake db:drop # get rid of the database, created previously (it'll be recreated again later) #> rm -rf markus_trunk # get rid of the MarkUs source code possibly checked out previously (you might do a "cd .." prior to that)
Happy Coding!