foodsoft/doc/SETUP_DEVELOPMENT.md

Getting foodsoft running for development

Gratulations, if you read this file locally, you have successfully cloned the foodsoft project from the git repository. Now you are only a few steps away from trying it out and then jumping into development.

System requirements: RVM (recommended), Ruby 2.0 and Bundler.

Getting started

0. Clone the repository from GitHub:

   git clone https://github.com/foodcoops/foodsoft.git
   

   This brings up the bleeding-edge development version, which might contain some unfinished parts. If you want to be safe, choose the last release: git checkout $(git tag -l | grep ^v | sort -rn | head -n1)

1. Install RVM and Ruby 2.0 (if you have not done so before):

   \curl -L https://get.rvm.io | bash
   source ~/.rvm/scripts/rvm
   rvm install 2.0
   

   We try to keep foodsoft compatible with Ruby 1.9.3 as well as any later versions, so if you have those and don't want to use RVM, that might actually work.

2. Install Ruby dependencies:

   bundle install
   

3. Setup your development environment:

   rake foodsoft:setup_development
   

   This will interactively prompt with several questions relating to your required environment.

4. Start rails by running:

   bundle exec rails s
   

5. Open your favorite browser and open the web application at:

   http://localhost:3000/
   

   You might want to watch a kitten video while it's loading.

6. Login using the default credentials: admin/secret

7. Change the admin password, just in case.

8. Have phun!

Manual configuration

The rake task foodsoft:setup_development helps you to setup foodsoft. If you want to have more control, you can do these steps manually as explained here.

1. Configure database

   Create the database configuration from the default:

   cp config/database.yml.SQLite_SAMPLE config/database.yml
   

   If you are fine with using a file-based sqlite database you are all set. The sqlite files (development/test/production) will reside in the "db" directory. Otherwise you would want to copy one of the other "database.yml.*_SAMPLE" files and edit database.yml to suit your needs.

2. Configure development environment

   Again, you need to create your own copy of the default configuration:

   cp config/environments/development.rb.SAMPLE config/environments/development.rb
   

   Edit development.rb to specify your settings (at least the ActionMailer SMTP settings). If you just leave the file as is, emails will not work but everything else should be okay.

3. Foodsoft settings

   You need to create your own copy of the foodsoft configuration settings:

   cp config/app_config.yml.SAMPLE config/app_config.yml
   

   Edit app_config.yml to suit your needs or just keep the defaults for now.

4. Secret token

   The user session are stored in cookies. Do avoid misusing the cookies and its sensitive information, rails will encrypt it with a token. So copy the config file

   cp config/initializers/secret_token.rb.SAMPLE config/initializers/secret_token.rb
   

   and modify the token!! You can run bundle exec rake secret

5. Create database (schema) and load defaults

   rake db:setup
   

   With this, you also get a ready to go user with username 'admin' and password 'secret'.

6. (optional) Get background jobs done

   We use for time intensive tasks a background job queue, at the moment resque with redis as key/value store. Install redis (in ubuntu the package redis-server works out of the box) and start the resque worker with:

   rake resque:work QUEUE=foodsoft_notifier
   

   To have look on the current queue, failed jobs etc start the resque server with

   resque-web
   

7. (optional) View mails in browser instead in your logs

   We use mailcatcher in development mode to view all delivered mails in a browser interface. Just install mailcatcher with gem install mailcatcher and start the service with

   mailcatcher
   

   From now on you have a smtp server listening on 1025. To see the emails go to

   http://localhost:1080