foodcoopshop/foodcoopshop

The open source software for your foodcoop


README

An easy-to-use open source software for food-coops.

Latest stable version Build status Software license

FoodCoopShop provides plenty of useful functions to help the people running a food-coop. Such as:

  • a user-friendly web shop for the consumers
  • an admin area for both manufacturers and admins
  • a fully automated payment system based on a credit system
  • different delivery rhythms for products
  • adapting orders in many ways
  • stock management... and much more!

The software can be used with any modern web browser, tablet or smartphone. It's available in German, English and Polish.

Links

Who uses FoodCoopShop?

Legal information

  • Before installing please read the legal information in German or English.

Requirements

  • Server with shell access and cronjobs
  • Apache with mod_rewrite
  • PHP >= 7.2
  • MySQL >= 5.6
  • Node.js and npm (installation) developer packages
  • Composer (installation) developer packages
  • Basic understanding of Apache Webserver, MySQL Database and Linux Server administration
  • PHP needs to be able to call mysqldump with exec() for database backups

Setting up dev environment / Installation

  • Follow the installation guide for setup.
  • If you have questions please create a new issue on Github.
  • Before doing any of the configuration changes, follow the steps below.
  • If you work on a local machine, do not change the owner of the files to www-data. Instead set permissions as shown below

Install required packages

Install the composer vendors

$ composer install

Install packages from package.json

$ npm --prefix ./webroot install ./webroot

Setting permissions

$ cd /path/to/project
$ chmod -R a+w ./files_private
$ chmod -R a+w ./tmp
$ chmod -R a+w ./webroot/cache
$ chmod -R a+w ./webroot/files
$ chmod -R a+w ./webroot/tmp

Unit Testing

$ vendor/bin/phpunit