brunosimioni / orderfy

proof of technology for an e-commerce platform by using several bleeding-edge technologies

orderfy

Proof-of-technology

A simple proof-of-technology for an ecommerce platform. This is a currently work-in-progress, composed by following techs:

Foundation, Architecture and CI

• Spring Boot 1.4.0 testing [done]
• Travis CI continuous integration [done]
• Coveralls for static analysis and code lint [partially done]
• Spring Cloud and Spring Cloud Netflix OSS [done]
• Clean Architecture [done]
• Google Protobuf Protocol [done]
• Swagger API documentation with Spring Fox [done]
• Golang REST API [partially done]
• Scala REST API (Play! Framework) [not started yet]
• Gatling, Netty and Akka [done]

Data Mining

• Apache Kafka [not started yet]
• Apache Spark [not started yet]

Data Storage and processing

• Apache Cassandra [not started yet]
• RabbitMQ and Spring Cloud Stream [done]
• Redis [partially done]
• MongoDB [partially done]
• Docker Compose for local deployment with wait-for-it dependencies [done]
• Kubernetes for cloud-native deployment [partially done]

Basic project organization

• backend-modules: Backend modules for orderfy platform
• frontend-modules: Frontend modules for orderfy platform
• tpsource-modules: 3rd-party modules as source of external integrations
• insights-modules: Insights and analytics modules for orderfy platform
• quality-modules: Following Testing microservices by Martin Fowler
• toolbox-modules: Toolbox and common modules to keep orderfy up&running
• traffic-generator: A simple random traffic generator for orderfy platform
• scripts: Build and run tools
• configs: Spring Cloud Config Server files
• newrelic: New Relic APM modules configuration files

Application Modules [wip]

Every java-based backend module requests by using Hystrix and Feign, granting circuit-breakers on integrations.

Backend

• backend-modules/catalog-service: a wrapper service to Akeneo PIM
• backend-modules/checkout-service: a simple cart&checkout service by consuming discovery services, powered by hystrix circuit-breakers, monitoring and API documentation
• backend-modules/customers-service: a customer-oriented MDM
• backend-modules/lists-service: a Golang REST api for wish lists
• backend-modules/orders-service: a Spring Cloud Stream (RabbitMQ) wrapper for orders processing
• backend-modules/search-service: a thin Elastic-search wrapper, enabled by Protobuf protocol

Toolbox

• toolbox-modules/apigateway-service: Netflix OSS Zuul API Gateway
• toolbox-modules/circuitmonitor-service: Netflix OSS Turbine (Hystrix aggregator monitor)
• toolbox-modules/config-service: Spring Cloud Config Server
• toolbox-modules/discovery-service: Netflix OSS Eureka service discovery server
• toolbox-modules/instancesadmin-service: Spring Boot Admin server

Traffic Feed

• traffic-generator: Gatling Framework (Akka / Play / Scala) powered stress tests

Run it

1. mvn clean install
2. docker-compose up

Inspect it

• Spring Cloud Zuul (API Gateway): http://localhost:8000/
• Spring Cloud Zuul Routes (API Gateway): http://localhost:8000/routes
• Spring Cloud Eureka: http://localhost:8001/
• Spring Cloud Turbine: http://localhost:8002/hystrix/monitor?stream=http%3A%2F%2Flocalhost%3A8989%2Fturbine.stream
• RabbitMQ exchanges and queues: http://localhost:15672/ [guest:guest]
• Orderfy Backend Catalog Service: http://localhost:9000/
• Orderfy Backend Customers Service: http://localhost:9001/
• Orderfy Backend Checkout Service: http://localhost:9002/
• Orderfy Backend Checkout Service Swagger 2.0 docs: http://localhost:9002/v2/api-docs
• Orderfy Backend Checkout Service Swagger UI: http://localhost:9002/swagger-ui.html
• Orderfy Backend Search Service: http://localhost:9003/