Skip to content
This repository has been archived by the owner on Oct 31, 2023. It is now read-only.

buckybox/core

Repository files navigation

Bucky Box Core

Build Status Coverage Report Code Climate

Bucky Box Core is part of the Bucky Box platform.

It is targeted to food producers and distributors to:

  • manage customers
  • aggregate orders
  • generate delivery lists
  • reconcile payments

It is composed of three parts:

  • distributor area (customer database + deliveries + payments)
  • customer area (order management)
  • API to interface with the Web Store App

Screenshot

Configuration

See config/application.yml:

  • required variable: SECRET_TOKEN
  • to send emails (recommended): SMTP_HOST, SMTP_USERNAME and SMTP_PASSWORD
  • to interface with the web store (optional): API_MASTER_KEY and API_MASTER_SECRET
  • other variables can be left to default values.

Ruby version and system dependencies

See CI config.

Services

  • Postgresql 9.5+ (main DB)
  • Redis (cache store)

Installation and deployment

See INSTALL.md.

Contributing

Any bug fix or tweak is welcomed but if you have bigger plans, please drop us a line at support AT buckybox.com first.

Translation

You can help translate it into your favorite language. We use Transifex. New translations can be fetched with tx pull -af.

Tests

./script/ci
# or
git commit && gitlab-ci-multi-runner exec docker integration

License

See LICENSE.