Skip to content

Latest commit

 

History

History
49 lines (27 loc) · 1.79 KB

README.md

File metadata and controls

49 lines (27 loc) · 1.79 KB

Curacao

An open source toolkit for building REST/HTTP-based integration layers on top of asynchronous servlets.

Introduction

Writing comprehensive documentation is hard, but a reasonable introduction to Curacao can be found here.

As the project matures, I intend to write out more documentation.

Latest Version

See the Releases page to find the latest version.

Compiling

Curacao requires Java 11 or later, and is packaged using Maven.

To compile & package the source:

mvn clean package

Resulting JARs and source JARs will be placed into the local dist directory.

Running the Examples

Working examples that demonstrate Curacao's flexibility can be found in the curacao-examples project.

In the spirit of "eating my own dog food", my own blog is built on Curacao and is fully open source on GitHub. If you're looking for more complex component definitions, and realistic request mapping and response handling examples, the application source of my blog will be a great start.

To compile and run the examples locally:

mvn -am -pl curacao-examples package -Pjetty-run

Then hit http://localhost:8080/curacao in your favorite browser.

License

Copyright (c) 2024 Mark S. Kolich

All code in this project is freely available for use and redistribution under the MIT License.

See LICENSE for details.