→ For Mconf-Web version 0.8.

→ This version uses Rails 3 and Ruby 1.9.2-p290.

Setting up the development environment

Manual setup

• First, you need to install some system packages used by Mconf-web (you can also see this list of packages in this file in our repository):

  $ sudo apt-get install wget make curl git-core libruby aspell-es aspell-en libxml2-dev \
                       libxslt1-dev libmagickcore-dev libmagickwand-dev imagemagick \
                       libmysqlclient-dev mysql-server zlib1g-dev build-essential \
                       libreadline-dev libsqlite3-dev libssl-dev
  

• Then install Ruby. We recommend the use of RVM. See this page to now how to install it (use the single-user installation). After RVM is installed, install Ruby and create a gemset for mconf with:

  $ rvm install 1.9.2-p290
  $ rvm gemset create mconf
  $ rvm use --default 1.9.2-p290@mconf
  

• Clone mconf-web and create a branch for version 0.8.1:

  $ git clone git://github.com/mconf/mconf-web.git
  $ git checkout -b branch-v0.8.1 v0.8.1
  

• Install gems and git submodules with:

  $ git submodule init
  $ git submodule update
  $ bundle install
  

• Set up your system (it creates some configuration files and updates git submodules):

  $ bundle exec rake setup:basic
  

• Configuration files. The command above created some files that you need to configure to be able to run the application. They are already formatted with a standard structure, but some information is sensible and unique for each setup, so you really need to edit them. The files are:

  • config/database.yml: configures the database. See [[this page

    Configuration-Files-v0.8#configuring-the-database-databaseyml]] for more details about this file.

  • config/setup_conf.yml contains the basic configuration data that will be used during the database setup and when the application is initialized. See [[this page

    Configuration-Files-v0.8#configuring-the-application-setup_confyml]] for more details about this file.

  • config/deploy/conf.yml configurations for deployment with Capistrano.

• Setup the database. It will drop and recreate your development database, create basic data (you need this data to run the application) and populate the db with test data.

  $ bundle exec rake setup:db
  

• Run the command below to start the server and open your browser and go to localhost:3000.

  $ bundle exec rails server
  

Fake test data

You can create fake data in your development database using the following rake task:

$ bundle exec rake setup:populate

It will create users, spaces, posts and everything you need to have a populated web site and test your modifications.

Testing

Development Tips

Configuring the website