m-dwyer / hanami

The web, with simplicity.

Hanami 🌸

The web, with simplicity.

Version

This branch contains the code for hanami 2.0.x.

Frameworks

Hanami is a full-stack Ruby web framework. It's made up of smaller, single-purpose libraries.

This repository is for the full-stack framework, which provides the glue that ties all the parts together:

• Hanami::Router - Rack compatible HTTP router for Ruby
• Hanami::Controller - Full featured, fast and testable actions for Rack
• Hanami::View - Presentation with a separation between views and templates
• Hanami::Helpers - View helpers for Ruby applications
• Hanami::Mailer - Mail for Ruby applications
• Hanami::Assets - Assets management for Ruby

These components are designed to be used independently or together in a Hanami application.

Status

Installation

Hanami supports Ruby (MRI) 3.0+

gem install hanami

Usage

hanami new bookshelf
cd bookshelf && bundle
bundle exec hanami server # visit http://localhost:2300

Please follow along with the Getting Started guide.

Donations

You can give back to Open Source, by supporting Hanami development via GitHub Sponsors.

Supporters

• Trung Lê
• James Carlson
• Creditas

Contact

• Home page: http://hanamirb.org
• Community: http://hanamirb.org/community
• Guides: https://guides.hanamirb.org
• Snippets: https://snippets.hanamirb.org
• Mailing List: http://hanamirb.org/mailing-list
• API Doc: http://rdoc.info/gems/hanami
• Bugs/Issues: https://github.com/hanami/hanami/issues
• Stack Overflow: http://stackoverflow.com/questions/tagged/hanami
• Forum: https://discourse.hanamirb.org
• Chat: http://chat.hanamirb.org

Community

We strive for an inclusive and helpful community. We have a Code of Conduct to handle controversial cases. In general, we expect you to be nice with other people. Our hope is for a great software and a great Community.

Contributing

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

In addition to contributing code, you can help to triage issues. This can include reproducing bug reports, or asking for vital information such as version numbers or reproduction instructions. If you would like to start triaging issues, one easy way to get started is to subscribe to hanami on CodeTriage.

Development Requirements

• Ruby >= 3.0
• Bundler
• Node.js (MacOS)

Testing

In order to simulate installed gems on developers' computers, the build installs all the gems locally in vendor/cache, including hanami code from lib/.

Before running a test, please make sure you have a fresh version of the code:

bundle exec rspec spec/path/to/file_spec.rb

Versioning

Hanami uses Semantic Versioning 2.0.0

Copyright

Copyright © 2014-2022 Hanami Team – Released under MIT License.