Files
openfoodnetwork/README.markdown
Rohan Mitchell 6ca56cbb94 Add AGPL licence
2012-12-18 15:56:54 +11:00

2.0 KiB

Open Food Web

Connect suppliers (ie. farmers), distributors (ie. co-ops) and consumers (ie. local food lovers) for the sale and purchase of local produce.

Dependencies

  • Rails 3.x
  • Ruby >= 1.9.2
  • PostgreSQL database
  • See Gemfile for a list of gems required

Get it

The source code is managed with Git (a version control system) and hosted at GitHub.

You can view the code at:

https://github.com/eaterprises/openfoodweb

You can download the source with the command:

git clone git@github.com:eaterprises/openfoodweb

Get it running

For those new to Rails, the following tutorial will help get you up to speed with configuring a Rails environment: http://guides.rubyonrails.org/getting_started.html .

First, check your dependencies: Ensure that you have Ruby 1.9.x installed:

ruby --version

Install the project's gem dependencies:

bundle install

Create the development and test databases, using the settings specified in config/database.yml. You can then load the schema and some seed data with the following command:

rake db:schema:load db:seed

At long last, your dreams of spinning up a development server can be realised:

rails server

Testing

Tests, both unit and integration, are based on RSpec. To run the test suite, first prepare the test database:

bundle exec rake db:test:load

Then the tests can be run with:

bundle exec rspec spec

The site is configured to use Spork to reduce the pre-test startup time while Rails loads. To use it, first start up a spork instance:

bundle exec spork

When that's ready, you can run RSpec with the --drb flag:

bundle exec rspec --drb spec

Deployment

Deployment is achieved using Heroku. For access, speak to Andrew Spinks.

Credits

Licence

Copyright (c) 2012 Eaterprises, released under the AGPL licence.