dairycart

Dairycart

Dairycart is an open-source eCommerce platform written in Go.

Status

Dairycart is currently pre-Alpha, and isn't suitable for production use as of yet. There is no stable, defined API, and until version 1.0 is released and tagged, any route should be considered volatile and subject to change with no notice.

Dependencies

To run Dairycart locally, all you need is Docker, and a bash terminal. 🙂

Running

To run the Dairycart API server, simply execute make run after cloning this repository locally.

Testing

There are two test suites, currently, a set of unit tests for the API server, and a suite of integration tests, which attempt to test the API server with real-world style requests. You can run the unit tests by executing make unit-tests, and you can run the integraiton tests similarly by executing make integration-tests.

Reporting Issues

Thusfar, Dairycart's development has been a solo effort, and this may still be the case for some time. That being the case, there are most definitely issues with the code that warrant reporting. Any issues can be reported using the Github Issue Tracker for this repository. Please ensure any issues filed adhere to the Code of Conduct and contributing guidelines.

Getting involved

General instructions on how to contribute can be found in CONTRIBUTING.

Open source licensing info

This project is licensed under the MIT License

A big thanks to the CFPB for the template this file is based on.