Skip to content

Latest commit

 

History

History
255 lines (174 loc) · 7.46 KB

README.md

File metadata and controls

255 lines (174 loc) · 7.46 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

tony-boot-starter

An awesome Spring Boot Starter!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

An awesome Spring Boot Starter!

Import the tony-boot-starter to get started.

back to top👆

Built With

Based on the principle of least dependency, different sub-module may rely on the following

back to top👆

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • Java 1.8+
  • Maven 3.6+

Installation

  1. Clone the repo

    git clone https://github.com/xuzhijvn/tony-boot-starters.git

  2. Install the packages to your local maven repo

    mvn install

  3. Import dependencies

    Import parent dependencies

    <dependency>
   <groupId>io.github.xuzhijvn</groupId>
   <artifactId>tony-boot-starter</artifactId>
   <version>1.0.8</version>
</dependency>

    or import sub-dependencies you need

    <dependency>
   <groupId>io.github.xuzhijvn</groupId>
   <artifactId>tony-boot-starter-component</artifactId>
   <version>1.0.4-SNAPSHOT</version>
</dependency>

back to top👆

Usage

For more examples, please refer to the Documentation

back to top👆

Roadmap

  • Add Changelog
  • Add back to top links
  • Add Additional Templates w/ Examples
  • Add "components" document to easily copy & paste sections of the readme
  • Multi-language Support
    • Chinese
    • English

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

back to top👆

License

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

back to top👆

Contact

QQ

[email protected]

back to top👆

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

back to top👆