<a href="https://onyxframework.org"><img width="100" height="100" src="https://onyxframework.org/img/logo.svg"></a>

Onyx

Built with Crystal Travis CI build Docs API docs Latest release

Powerful framework for modern applications.

About 👋

Onyx Framework is a powerful general purpose framework for Crystal language. It has the following goals:

The framework consists of the following loosely coupled components:

Supporters 🕊

Thanks to all these patrons, the framework lives and prospers 🙏

Lauri Jutila, Alexander Maslov, Anton Yordanov

You can become a patron too in exchange of prioritized support and other perks

<a href="https://www.patreon.com/vladfaust"><img height="50" src="https://onyxframework.org/img/patreon-button.svg"></a>

Installation 📥

Add this to your application's shard.yml:

dependencies:
  onyx:
    github: onyxframework/onyx
    version: ~> 0.4.0

This shard follows Semantic Versioning v2.0.0, so check releases and change the version accordingly.

Note that until Crystal is officially released, this shard would be in beta state (0.*.*), with every minor release considered breaking. For example, 0.1.00.2.0 is breaking and 0.1.00.1.1 is not.

Note that this shard does not have implicit dependencies for other framework components. For example, to use "onyx/http" macros, you must add onyx-http dependendency as well:

dependencies:
  onyx:
    github: onyxframework/onyx
    version: ~> 0.4.0
  onyx-http:
    github: onyxframework/http
    version: ~> 0.8.0

Documentation 📚

The documentation is available online at docs.onyxframework.org.

Community 🍪

There are multiple places to talk about this particular shard and about other ones as well:

Contributing

  1. Fork it ( https://github.com/onyxframework/onyx/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'feat: some feature') using Angular style commits
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

Licensing

This software is licensed under MIT License.

Open Source Initiative