Zero-overhead and minimalist web framework for Vert.x.
This small project aims to leverage Vert.x web developers productivity by providing them a zero-overhead and minimalistic API layer. It was carefully designed to not hide from developers how the software works underneath. Kos also embrace Vert.x philosophy: although it provides opinionated conventions, all of them are optional and provide an easy and transparent mechanism to avoid repetitive tasks.
Kos is for you if you need:
- a reflection-free layer over Vert.x web API
- a simplified way to spin up the web server
- automatically deploy Vert.x Verticles
- automatically load vertx-config configuration
The project name kos (pronounces like coosh) came from Norwegian and is a word used to describe all the things that make you feel cozy and warm inside.
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
- A reproducible test case or series of steps
- The version of our code being used
- Any modifications you've made relevant to the bug
- Anything unusual about your environment or deployment
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
- You are working against the latest source on the master branch.
- You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
- You open an issue to discuss any significant work - we would hate for your time to be wasted.
To send us a pull request, please:
- Fork the repository.
- Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
- Ensure local tests pass.
- Commit to your fork using clear commit messages.
- Send us a pull request, answering any default questions in the pull request interface.
- Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
GitHub provides additional document on forking a repository and creating a pull request.
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
This is release under the Apache License 2 terms.