buckybox/webstore

# Bucky Box Web Store

[![Build Status](https://gitlab.com/buckybox/webstore/badges/master/build.svg)](https://gitlab.com/buckybox/webstore/commits/master)
[![Build Status](https://travis-ci.org/buckybox/webstore.svg?branch=master)](https://travis-ci.org/buckybox/webstore)
[![Coverage Status](https://coveralls.io/repos/buckybox/webstore/badge.svg?branch=master&service=github)](https://coveralls.io/github/buckybox/webstore?branch=master)
[![Code Climate](https://codeclimate.com/github/buckybox/webstore/badges/gpa.svg)](https://codeclimate.com/github/buckybox/webstore)

Bucky Box Web Store is part of the [Bucky Box](http://www.buckybox.com/) platform.
It allows customers to place orders using the [Bucky Box API](https://api.buckybox.com/docs/).

![Screenshot](doc/screenshot.jpg)

## Configuration

See [config/application.yml](https://github.com/buckybox/webstore/blob/master/config/application.yml.example).
The required settings are `BUCKYBOX_API_KEY`, `BUCKYBOX_API_SECRET` and `SECRET_KEY_BASE`. You can leave the rest blank.

## Services

No database is required but you must have [Redis](http://redis.io/) running to store carts.

## Deployment instructions

```bash
cp config/application.yml.example config/application.yml
RAILS_ENV=development bundle exec puma -p 5000 --config config/puma.rb --log-requests
```

## 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](https://www.transifex.com/projects/p/buckybox-webstore/).
New translations can be fetched with `tx pull -af`.

## Tests

```bash
./bin/ci
# or
git commit && gitlab-ci-multi-runner exec docker integration
```

## License

GPLv3+