Table of Contents

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

About The Project

(back to top)

Built With

• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Installation

Usage

Check Makefile targets

(back to top)

Roadmap

• Openapi generator
• Graceful shutdown
• Makefile based
• Git hooks
• Internal endpoints
  • Healthcheck
  • ReDoc
• Prometheus metrics

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)

Acknowledgments

• OpenAPI Generator
• Choose an Open Source License
• README template

(back to top)

Notes

• Makefile MUST NOT change well-defined command semantics, see Makefile for details.
• cmd and build MUST have the same set of subdirectories for main targets
  • For example, cmd/admin,cmd/controller and build/admin,build/controller.
  • Dockerfile MUST be put under build directory even if you have only one Dockerfile.