Foodsoft/foodsoft
1
1
Fork 0
Code Issues 36 Pull requests 5 Projects 1 Releases Wiki Activity

split and cleanup documentation [ci skip]

Browse source
This commit is contained in:
wvengen 2013-10-29 15:27:26 +01:00
parent 50d2991cc0
commit 75059d5bcf
4 changed files with 168 additions and 155 deletions
Download patch file Download diff file Expand all files Collapse all files

69
README.md
View file

@ -3,78 +3,29 @@ FoodSoft
[![Build Status](https://travis-ci.org/foodcoops/foodsoft.png)](https://travis-ci.org/foodcoops/foodsoft)
[![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)
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/foodcoops/foodsoft/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/foodcoops/foodsoft/trend.png)](https://bitdeli.com/foodcoops "Bitdeli Badge")
Web-based software to manage a non-profit food coop (product catalog, ordering, accounting, job scheduling).
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, see [doc/SETUP_DEVELOPMENT](https://github.com/foodcoops/foodsoft/blob/master/doc/SETUP_DEVELOPMENT.md) on how to set it up on your own computer.
More information about using this software and contributing can be found on the [wiki](https://github.com/foodcoops/foodsoft/wiki).
System requirements
-------------------
* [RVM](https://rvm.io/rvm/install)
* [Ruby 1.9.3](https://www.ruby-lang.org/en/downloads/)
* [Bundler](http://bundler.io/)
Getting started
---------------
1. Install RVM (if you have not done so before):
```
\curl -L https://get.rvm.io | bash
```
2. Clone the repository from GitHub:
```
git clone https://github.com/foodcoops/foodsoft.git
```
3. Install Ruby dependencies:
```
bundle install
```
4. Setup your development environment:
```
rake foodsoft:setup_development
```
This will interactively prompt with several questions relating to your
required environment.
5. Start rails by running:
```
bundle exec rails s
```
6. Open your favorite browser and open the web application at:
```
http://localhost:3000/
```
You might want to watch a
[kitten video](https://www.youtube.com/watch?v=9Iq5yCoHp4o)
while it's loading.
7. Login using the default credentials: `admin/secret`
8. Change the admin password, just in case.
9. Have phun!
Developing
----------
Have a look at [DEVELOPMENT.md](https://github.com/foodcoops/foodsoft/blob/master/doc/DEVELOPMENT.md) (outdated) and the (more recent) [Developing Guidelines](https://github.com/foodcoops/foodsoft/wiki/Developing-Guidelines) page on the wiki.
Get foodsoft [running locally](https://github.com/foodcoops/foodsoft/blob/master/doc/SETUP_DEVELOPMENT.md),
then visit our [Developing Guidelines](https://github.com/foodcoops/foodsoft/wiki/Developing-Guidelines)
page on the wiki.
Deploying
---------
As you might have noticed, documentation is scarce and insufficient. If you
intend to deploy foodsoft in production, we would love to guide you through
the process. You can contact the mailing list
[foodsoft-discuss](http://foodsoft.51229.x6.nabble.com/foodsoft-discuss-f5.html),
or mail some of us directly at
[developers@foodcoop.nl](mailto:developers@foodcoop.nl) or
foodsoft (at) foodcoops.net.
Please see [doc/SETUP_PRODUCTION](https://github.com/foodcoops/foodsoft/blob/master/doc/SETUP_PRODUCTION.md),
as well as[doc/DEPLOYMENT](https://github.com/foodcoops/foodsoft/blob/master/doc/DEPLOYMENT.md).
License
-------