Connect suppliers, distributors and consumers for the sale and purchase of local produce
Switch branches/tags
Clone or download
Pull request Compare This branch is 764 commits behind openfoodfoundation:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
.tx
app
config
db
doc
lib
log
public
script
spec
vendor
.codeclimate.yml
.gitignore
.mailmap
.node-version
.rspec
.rspec_parallel
.rubocop.yml
.rubocop_todo.yml
.ruby-gemset
.ruby-version
.scss-lint.yml
.travis.yml
CONTRIBUTING.md
Gemfile
Gemfile.lock
Guardfile
LICENCE.txt
Procfile
README.md
Rakefile
config.ru
knapsack_rspec_report.json
package.json
zeus.json

README.md

Build Status Code Climate View performance data on Skylight

Open Food Network

The Open Food Network is an online marketplace for local food. It enables a network of independent online food stores that connect farmers and food hubs (including coops, online farmers' markets, independent food businesses etc); with individuals and local businesses. It gives farmers and food hubs an easier and fairer way to distribute their food.

Supported by the Open Food Foundation, we are proudly open source and not-for-profit - we're trying to seriously disrupt the concentration of power in global agri-food systems, and we need as many smart people working together on this as possible.

We're part of global movement - get involved!

Getting started

Below are instructions for setting up a development environment for Open Food Network. More information is in the developer wiki.

If you're interested in provisioning a server, see the project's Ansible playbooks.

Dependencies

  • Rails 3.2.x
  • Ruby 2.1.5
  • PostgreSQL database
  • PhantomJS (for testing)
  • 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/openfoodfoundation/openfoodnetwork

You can download the source with the command:

git clone https://github.com/openfoodfoundation/openfoodnetwork.git

Get it running

For those new to Rails, the following tutorial will help get you up to speed with configuring a Rails environment.

When ready, run script/setup. If the script succeeds you're ready to start developing. If not, take a look at the output as it should be informative enough to help you troubleshoot.

If you run into any other issues getting your local environment up and running please consult the wiki.

If still you get stuck do not hesitate to open an issue reporting the full output of the script.

Now, your dreams of spinning up a development server can be realised:

bundle exec rails server

To login as Spree default user, use:

email: spree@example.com
password: spree123

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:prepare

Then the tests can be run with:

bundle exec rspec spec

The site is configured to use Zeus to reduce the pre-test startup time while Rails loads. See the Zeus github page for usage instructions.

Once npm dependencies are installed, AngularJS tests can be run with:

./script/karma run

If you want karma to automatically rerun the tests on file modification, use:

./script/karma start

Multilingual

Do not forget to run rake tmp:cache:clear after locales are updated to reload I18n js translations.

Credits

Licence

Copyright (c) 2012 - 2015 Open Food Foundation, released under the AGPL licence.