foodsoft/README.md

40 lines
2.1 KiB
Markdown
Raw Normal View History

2014-03-17 13:37:29 +01:00
Foodsoft
2013-05-25 15:03:31 +02:00
=========
2014-01-08 14:45:10 +01:00
[![Build Status](https://travis-ci.org/foodcoops/foodsoft.png?branch=master)](https://travis-ci.org/foodcoops/foodsoft)
[![Coverage Status](https://coveralls.io/repos/foodcoops/foodsoft/badge.png?branch=master)](https://coveralls.io/r/foodcoops/foodsoft?branch=master)
[![Docs Status](http://inch-ci.org/github/foodcoops/foodsoft.png?branch=master)](http://inch-ci.org/github/foodcoops/foodsoft)
2013-06-17 02:59:36 +02:00
[![Code Climate](https://codeclimate.com/github/foodcoops/foodsoft.png)](https://codeclimate.com/github/foodcoops/foodsoft)
[![Dependency Status](https://gemnasium.com/foodcoops/foodsoft.png)](https://gemnasium.com/foodcoops/foodsoft)
[![Documentation](http://b.repl.ca/v1/yard-docs-blue.png)](http://rubydoc.info/github/foodcoops/foodsoft/frames)
2009-01-06 11:49:19 +01:00
Web-based software to manage a non-profit food coop (product catalog, ordering, accounting, job scheduling).
2013-11-07 19:08:33 +01:00
A food cooperative is a group of people that buy food from suppliers of their own choosing. A collective do-it-yourself supermarket. Members order their products online and collect them on a specified day. And all put in a bit of work to make that possible. Foodsoft facilitates the process.
2013-10-29 15:31:49 +01:00
If you're a food coop considering to use foodsoft, please have a look at the [wiki page for foodcoops](https://github.com/foodcoops/foodsoft/wiki/For-foodcoops). When you'd like to experiment with or develop foodsoft, you can read [how to set it up](https://github.com/foodcoops/foodsoft/blob/master/doc/SETUP_DEVELOPMENT.md) on your own computer.
2013-10-28 16:26:44 +01:00
More information about using this software and contributing can be found on the [wiki](https://github.com/foodcoops/foodsoft/wiki).
2013-10-28 16:26:44 +01:00
Developing
----------
2014-06-01 00:46:43 +02:00
Get foodsoft [running locally](doc/SETUP_DEVELOPMENT.md),
then visit our [Developing Guidelines](https://github.com/foodcoops/foodsoft/wiki/Developing-Guidelines)
page on the wiki.
2013-10-28 16:36:04 +01:00
Deploying
---------
2014-06-01 00:46:43 +02:00
Setup foodsoft to [run in production](doc/SETUP_PRODUCTION.md),
and automate [deployment](doc/DEPLOYMENT.md). This section is
2013-10-29 15:39:56 +01:00
very much a work in progress.
2013-10-28 16:36:04 +01:00
2013-05-25 15:03:31 +02:00
License
-------
2009-01-06 11:49:19 +01:00
2014-06-01 00:46:43 +02:00
GPL version 3 or later, please see [LICENSE](LICENSE.md) for the full text.
2009-01-06 11:49:19 +01:00