MSS Boot 🚀

Welcome to MSS Boot, a microservice rapid development framework designed to streamline the creation and deployment of microservices using Istio and Kubernetes. This framework simplifies the complexities of microservice architecture, allowing developers to focus on building robust applications.

Table of Contents

• Features
• Getting Started
• Installation
• Usage
• Configuration
• Contributing
• License
• Releases

Features

• Rapid Development: Build microservices quickly with pre-configured templates.
• Kubernetes Integration: Seamlessly deploy your services on Kubernetes.
• Istio Support: Leverage Istio for service mesh capabilities, including traffic management, security, and observability.
• Extensible: Easily add new functionalities and integrations as your application grows.
• Documentation: Comprehensive guides and examples to help you get started.

Getting Started

To get started with MSS Boot, follow these steps:

1. Clone the Repository:

   git clone https://github.com/morytoh/mss-boot.git
   cd mss-boot

2. Install Dependencies: Make sure you have the required tools installed. Check the documentation for a list of dependencies.

3. Run the Application: Follow the instructions in the documentation to run your first microservice.

Installation

To install MSS Boot, download the latest release from our Releases page. You will need to download the appropriate file for your operating system and execute it.

Example for Linux

wget https://github.com/morytoh/mss-boot/releases/download/v1.0.0/mss-boot-linux
chmod +x mss-boot-linux
./mss-boot-linux

Example for Windows

Download the executable from the Releases page and run it.

Usage

Once installed, you can create a new microservice by running:

mss-boot create my-service

This command generates a new microservice with the name my-service. You can then customize the service as needed.

Service Structure

The generated service will have the following structure:

my-service/
├── src/
│   └── main/
│       └── java/
│           └── com/
│               └── example/
│                   └── myservice/
├── Dockerfile
└── README.md

Configuration

MSS Boot allows you to configure various aspects of your microservice. The configuration files are located in the src/main/resources directory. You can set parameters such as database connections, service endpoints, and more.

Example Configuration

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: user
    password: password

Contributing

We welcome contributions to MSS Boot. To contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch: git checkout -b feature/my-feature.
3. Make your changes and commit them: git commit -m 'Add my feature'.
4. Push to the branch: git push origin feature/my-feature.
5. Open a Pull Request.

Please ensure that your code adheres to our coding standards and includes tests where applicable.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Releases

For the latest updates and releases, visit our Releases page. You can download the necessary files and execute them to get started with MSS Boot.

Conclusion

MSS Boot provides a solid foundation for developing microservices using Istio and Kubernetes. With its ease of use and extensive features, it enables developers to build scalable applications efficiently. We encourage you to explore the framework and contribute to its growth.

Feel free to reach out with any questions or feedback. Happy coding!