Powerful framework for modern applications.
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
Thanks to all these patrons, the framework lives and prospers 🙏
Lauri Jutila, Alexander Maslov, Anton Yordanov, Dainel Vera
You can become a patron too in exchange of prioritized support and other perks
Add this to your application's shard.yml
:
dependencies:
onyx:
github: onyxframework/onyx
version: ~> 0.6.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.0
→0.2.0
is breaking and0.1.0
→0.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.6.0
onyx-http:
github: onyxframework/http
version: ~> 0.9.0
The documentation is available online at docs.onyxframework.org.
There are multiple places to talk about this particular shard and about other ones as well:
- Fork it ( https://github.com/onyxframework/onyx/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'feat: some feature') using Angular style commits
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
- Vlad Faust - creator and maintainer
This software is licensed under MIT License.