Micro-Service-Cola

A micro service version of cola architecture.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This project is a scaffold for a microservice version of a Maven project built on the COLA structure, allowing you to quickly set up a development environment using Maven Archetype.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

• JDK 17
• Maven
• MySQL 8.0 (optional)
• Redis 7.0 (optional)
• Nacos v2.3.2 (optional)
• RocketMQ 5.1.4 (optional)

Installation

1. Clone the repo

   git clone https://github.com/hnzhrh/micro-service-cola.git

2. Install the archetype to local repo

   cd ./micro-service-cola-archetype
   mvn install

Now you can use this archetype to create the new project.

(back to top)

Usage

There are two methods for generating the archetype:

1. Using the Maven Archetype Plugin.
2. Through the web user interface (UI).

Using the Maven Archetype Plugin.

Before creating your project, please replace ${groupId}, ${artifactId}, ${package}, and ${version} with your own values.

mvn archetype:generate -DgroupId=${groupId} -DartifactId=${artifactId} -Dversion=1.0.0 -Dpackage=${package} -DarchetypeArtifactId=micro-service-cola-archetype -DarchetypeGroupId=com.erpang.scaffold -DarchetypeVersion=1.0.0 -DarchetypeCatalog=local

Through the web user interface (UI).

1. Go to directory
2. Config the output-dir in application.yaml

   output-dir: Your output dir path.

3. Run the application.
4. Go to http://localhost:8180

(back to top)

Roadmap

• Init the project module
• Integrate Spring Boot
• Integrate COLA
• Integrate middleware
  • MySQL
  • Redis
  • RocketMQ
• Integrate Spring cloud alibaba.
  • Nacos
    • Config
    • Discovery
  • Sentinel
  • Seata
• Schedule tasks
  • Spring schedule tasks.
• Integrate monitor
  • Spring Boot Actuator
  • Prometheus
• Integrate observability platform
  • Skywalking
• Integrate development tools
  • Swagger and Knife4j
• Generator
  • Maven archetype
  • Generator
    • Implement a JSON-configurable strategy for generating directory structures.
    • Implement a configurable strategy for generating template files.
    • Support more archetype.
    • File download.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Erpang - [email protected]

Project Link: https://github.com/hnzhrh/micro-service-cola

(back to top)

Acknowledgments

• COLA
  • GitHub-COLA
  • 复杂度应对之道 - COLA应用架构
  • 应用架构COLA 2.0
  • 应用架构COLA3.0：让事情回归简单
  • 应用架构COLA 3.1：分类思维
  • COLA 4.0：应用架构的最佳实践
• Spring cloud alibaba
  • Spring cloud alibaba sca

(back to top)