sedhossein / mohtaseb

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Mohtaseb

Mohtaseb is a simple finance system. It consists of two microservices which each is responsible for an specific domain. Nginx is used as the API gateway.

πŸš€ Quick start

You will be needing docker to be installed in order to be able to run this project.

Run make up and wait for some seconds.

πŸ“¦ API

After running the project, a full swagger API documentation is exposed on / route as the frontend. It should be accessible at http://127.0.0.1:8080/. You can use the "Try it button"s on that page to make requests.

πŸ§ͺ Tests

Tests can be run by executing make test. It will try to run all the tests, service-wise.

Services

πŸ’° Jib

Jib is a service responsible for storing financial transactions and also calculating wallet balances.

πŸ‘¨β€ Karim

Karim is the merciful service which gives gift codes. It takes care of keeping track of gift code usages, and also notifying Jib about gift code consumptions.

β˜€οΈ Frontend

Serves a Swagger API documentation. The hosted documentation is available on / path on the main Nginx.

About


Languages

Language:PHP 95.8%Language:HTML 2.8%Language:Dockerfile 1.2%Language:Makefile 0.2%