Skip to content

How to Contribute

Apitomy Axiom is open source under the Apache License 2.0. We welcome contributions of all kinds — bug reports, feature requests, documentation improvements, and code contributions.

Getting Involved

  • Report bugs or request features on GitHub Issues
  • Read the contributing guide at CONTRIBUTING.md for development setup, coding conventions, and pull request guidelines
  • Review the README at README.md for an overview of the project structure and build instructions

Building from Source

To build and run Axiom for development, you'll need:

  • Java 25+
  • Maven 3.9+
  • Node.js 20+ (for the UI)
git clone https://github.com/Apitomy/apitomy-axiom.git
cd apitomy-axiom
./dev.sh

This starts the Quarkus backend on http://localhost:8080 and the Vite UI dev server on http://localhost:8888. See the README for full build instructions and development workflow details.