ponytales / marco

Simple OSGi enabled e-commerce backend.
0 stars 0 forks source link

Marco E-Commerce Backend

A simple yet generic ecommerce backend built on top of the OSGi specifications. It provides APIs as well as some implementations. For testing purposes a restful resources are included as well (based on the JAX-RS whiteboard specification).

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

All following commands are meant to be run from the project's root dir.

First we have to make it a valid bnd workspace, by adding a build.bnd:

touch cnf/build.bnd

I decided to remove it from my repository, so you can place your personal settings in it (as intend by bnd). It is also possible to place additional configurations into cnf/ext/*_local*.bnd files. These files are part of git's ignore list.

Afterwards you can build it by doing a

gradle clean

followed by a

gradle build

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

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

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