Files
openfoodnetwork/README.markdown
Rohan Mitchell cbeffaced1 Configure Travis, remove spork, add simplecov, add turbo sprokets.
Add travis config
(cherry picked from commit e3fdb12289)

Only build on Ruby 1.9.3
(cherry picked from commit 719ef386bf)

Exclude pry from CI build
(cherry picked from commit d60935c800)

Conflicts:

	Gemfile

Attempt 2
(cherry picked from commit 2b19253895)

Conflicts:

	Gemfile.lock

Configure travis for postgres
(cherry picked from commit 3a441cd7d9)

Fix migrations that fail because of coupling to changed/removed models
(cherry picked from commit b030793f15)

Set up xvfb for Travis
(cherry picked from commit cdc3ab09a1)

Add a failing test to test travis
(cherry picked from commit 72aa8fe5e5)

Revert "Add a failing test to test travis"

This reverts commit 72aa8fe5e5.
(cherry picked from commit bd5533e2b1)

Add simplecov
(cherry picked from commit 5089d3bb22)

Conflicts:

	Gemfile.lock

Add turbo sprockets for faster asset precompile
(cherry picked from commit 3e6c56a638)

Remove spork
(cherry picked from commit ed7bded642)

Conflicts:

	spec/spec_helper.rb

Remove more spork-specific things, remove unused cuc config from zeus
(cherry picked from commit fa11ff8982)

Ensure order decorator is required, fix test fragility
(cherry picked from commit 1e94f88c5e)
2013-06-07 16:23:24 +10:00

83 lines
1.9 KiB
Markdown

# 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
[Zeus](https://github.com/burke/zeus) to reduce the pre-test
startup time while Rails loads. See the Zeus github page for
usage instructions.
## Deployment
Deployment is achieved using [Heroku](http://heroku.com). For access,
speak to Andrew Spinks.
## Credits
* Andrew Spinks (http://github.com/andrewspinks)
* Rohan Mitchell (http://github.com/rohanm)
* Rob Harrington (http://github.com/oeoeaio)
## Licence
Copyright (c) 2012 Eaterprises, released under the AGPL licence.