Kangaroo

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 14)

Kangaroo is a sample open source goods delivery application, powered by microservices ☸️ architecture and cross-platform development 📱🖥🐳

Kangaroo Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Kangaroo
[![Gitter](https://badges.gitter.im/KangarooApp/community.svg)](https://gitter.im/KangarooApp/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Build Status](https://travis-ci.org/Jamaxack/Kangaroo.svg?branch=master)](https://travis-ci.org/Jamaxack/Kangaroo)
![Kangaroo.sln build](https://github.com/Jamaxack/Kangaroo/workflows/Kangaroo.sln%20build/badge.svg?branch=master)

Kangaroo is containerized microservices application based on .NET Core. The project demonstrates how to develop small microservices for larger applications using containers, orchestration, service discovery, gateway, and best practices. You are always welcome to improve code quality and contribute it, if you have any questions or issues don't hesitate to ask in our [gitter](https://gitter.im/KangarooApp/community) chat.

## Motivation

- Developing independently deployable and scalable micro-services
- Developing cross-platform beautiful mobile apps using React native
- Configuring CI/CD pipelines using Travis CI, Github Actions, automated deployments using Google Kubernetes Engine, Docker Containers
- Using modern technologies such as gRPC, RabbitMQ, Service meshes
- Writing clean, maintainable and fully testable code, Unit Testing, Integration Testing and Mocking practices
- Using SOLID Design Principles
- Using Design Patterns and Best practices such as DDD and CQRS

## Architecture overview

The architecture proposes a microservice oriented architecture implementation with multiple autonomous microservices (each one owning its own data/db) and implementing different approaches within each microservice (simple CRUD vs. DDD/CQRS patterns) using REST/HTTP as the communication protocol between the client apps, and supports asynchronous communication for data updates propagation across multiple services based on gRPC, Integration Events and an Event Bus(RabbitMQ)

## List of micro-services and infrastructure components

<table>
   <thead>
    <th>№</th>
    <th>Service</th>
    <th>Description</th>
    <th>Build status</th>
    <th>Endpoints</th>
  </thead>
  <tbody>
    <tr>
        <td align="center">1.</td>
        <td>Delivery API (DDD, CQRS, EF Core, Dapper, SQL Server)</td>
        <td>Deals with Delivery book/orders and their statuses</td>
        <td>
            <a href="https://github.com/Jamaxack/Kangaroo/actions?query=workflow%3ADelivery.API">
                <img src="https://github.com/Jamaxack/Kangaroo/workflows/delivery-api/badge.svg?branch=master"> 
            </a>
        </td>
        <td>
           <a href="https://petstore.swagger.io/?url=https://raw.githubusercontent.com/Jamaxack/Kangaroo/master/src/Services/Delivery/Delivery.API/Swagger/v1/Swagger.json">
              View
           </a>
       </td>
    </tr>
    <tr>
        <td align="center">2.</td>
        <td>Courier API (CRUD, Repository, MongoDB)</td>
        <td>Manages Couriers and their deliveries with real time tracking and delivery status updates</td>
        <td>
            <a href="https://github.com/Jamaxack/Kangaroo/actions?query=workflow%3ACourier.API">
                <img src="https://github.com/Jamaxack/Kangaroo/workflows/courier-api/badge.svg?branch=master">
            </a>
        </td>
        <td>
            <a href="https://petstore.swagger.io/?url=https://raw.githubusercontent.com/Jamaxack/Kangaroo/master/src/Services/Courier/Courier.API/Swagger/v1/Swagger.json">
               View
            </a>
       </td>
    </tr>
    <tr>
        <td align="center">3.</td>
        <td>Pricing API (Redis Cache, Google Maps API)</td>
        <td>Calculates delivery price based on distance, delivery duration and goods weight. Uses Google Maps API</td>
        <td>
            <a href="https://github.com/Jamaxack/Kangaroo/actions?query=workflow%3APricing.API">
                <img src="https://github.com/Jamaxack/Kangaroo/workflows/pricing-api/badge.svg?branch=master">
            </a>
        </td>
        <td>
            <a href="https://petstore.swagger.io/?url=https://raw.githubusercontent.com/Jamaxack/Kangaroo/master/src/Services/Pricing/Pricing.API/Swagger/v1/Swagger.json">
               View
            </a>
       </td>
    </tr>
    <tr>
        <td align="center">4.</td>
        <td>Identity API(soon) (.NET Core + IdentityServer4)</td>
        <td>Identity management service, powered by OAuth2 and OpenID Connect</td>
        <td>
           (soon)
        </td>
        <td></td>
    </tr>
    <tr>
        <td align="center">5.</td>
        <td>Payment API(soon) (DDD, CQRS, Postresql)</td>
        <td>Responsible for financial and payments</td>
        <td>
           (soon)
        </td>
        <td></td>
    </tr>
  </tbody>  
</table>

## How to start the solution?

`cd` to cloned repository and execute:

```
docker-compose up
```
Available services:
-  <a href="http://localhost:3050/delivery/">Delivery service</a>
-  <a href="http://localhost:3050/courier/">Courier service</a>
-  <a href="http://localhost:3050/pricing/">Pricing service</a>
-  <a href="http://localhost:3050/kibana/">Kibana dashboard</a>

## Contributing

1. Fork it
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -m 'Adds some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request

## License

Code released under the [MIT license](https://github.com/Jamaxack/Kangaroo/blob/master/LICENSE).

Kangaroo

Kangaroo Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Kangaroo

Kangaroo Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README