Omura

E-commerce on the thin! A very small and tiny way to smooth over any hiccups for Stripe's Product API. Also includes the ability to add products and eventually capture payments.

Could be used as an e-commerce API layer for stores that want a little bit 'more control'.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Docker and Docker Compose

Installing

Grab and build relevant Docker Images:

    docker-compose build

Running the tests

Tests are run with minitest. The easiest way to run the entire suite with docker is:

    docker-compose run --rm web bundle exec ruby -Itest -e 'Dir["./test/**/{test_*,*_test}.rb"].each &method(:require)' --

And coding style tests

Autoformatting is provided by the wonderful rubyfmt. It's an exceptionally fast, opinionated, and well built tool for formatting .rb files.

Built With

Roda - The router for incoming requests.
Sorbet - Static type checker.
Stripe - Product feed and payment processing.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Braden Douglass - Initial work - Braidn

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

PurpleBooth - For wonderful readme templates.
Beluga - For inspiring me to build smaller ecom tooling and naming.
Spree/Solidus - For making e-commerce in Ruby fun.

braidn/omura