Powerful framework for modern applications 💪 https://api.onyxframework.org/onyx


  • v0.3.0 - March 10, 2019
  • v0.2.0 - March 10, 2019
  • v0.1.4 - February 27, 2019
  • v0.1.3 - February 26, 2019
  • v0.1.2 - February 20, 2019



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:

  • Joy for newcomers, yet an ability to scale with the developer's knowledge
  • Type-safety on top of Crystal's amazing built-in type system
  • Performance having minimum possible overhead

The framework consists of the following loosely coupled components:

  • Onyx::HTTP to build scalable web applications
  • Onyx::SQL to add SQL models to your business layer
  • Onyx::EDA to implement events-based reactivity

Supporters 🕊

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

Lauri Jutila, Alexander Maslov, Dainel Vera

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

Installation 📥

Add this to your application's shard.yml:

    github: onyxframework/onyx
    version: ~> 0.3.0

This shard follows Semantic Versioning v2.0.0, so check releases and change the version accordingly. Please visit github.com/crystal-lang/shards to know more about Crystal shards.

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:

    github: onyxframework/onyx
    version: ~> 0.3.0
    github: onyxframework/http
    version: ~> 0.7.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:


  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



This software is licensed under MIT License.

Open Source Initiative

Github statistic:
  • 27
  • 0
  • 1
  • 1
  • 6 days ago


MIT License