https://github.com/hanami/hanami
A flexible framework for maintainable Ruby apps
https://github.com/hanami/hanami
api hanami ruby ruby-application web web-application
Last synced: about 5 hours ago
JSON representation
A flexible framework for maintainable Ruby apps
- Host: GitHub
- URL: https://github.com/hanami/hanami
- Owner: hanami
- License: mit
- Created: 2013-08-09T15:24:44.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2025-04-18T22:36:41.000Z (4 days ago)
- Last Synced: 2025-04-19T10:19:43.839Z (3 days ago)
- Topics: api, hanami, ruby, ruby-application, web, web-application
- Language: Ruby
- Homepage: http://hanamirb.org
- Size: 25.6 MB
- Stars: 6,254
- Watchers: 174
- Forks: 539
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- toolbox - hanami - Another framework that I experimented with. I like that it has some of my favourite tools baked in, for example rspec and the interactor pattern. (Frameworks)
- awesome-for-beginners - Hanami
- awesome-list - hanami
- fucking-awesome-for-beginners - Hanami
README
# Hanami :cherry_blossom:
**A flexible framework for maintainable Ruby apps.**
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**](https://github.com/hanami/router) - Rack compatible HTTP router for Ruby
* [**Hanami::Controller**](https://github.com/hanami/controller) - Full featured, fast and testable actions for Rack
* [**Hanami::View**](https://github.com/hanami/view) - Presentation with a separation between views and templates
* [**Hanami::DB**](https://github.com/hanami/db) - Database integration, complete with migrations, repositories, relations, and structs
* [**Hanami::Assets**](https://github.com/hanami/assets) - Assets management for RubyThese components are designed to be used independently or together in a Hanami application.
## Status
[](https://badge.fury.io/rb/hanami)
[](https://github.com/hanami/hanami/actions?query=workflow%3Aci+branch%3Amain)## Installation
Hanami supports Ruby (MRI) 3.1+.
```shell
gem install hanami
```## Usage
```shell
hanami new bookshelf
cd bookshelf && bundle
bundle exec hanami dev
# Now visit http://localhost:2300
```Please follow along with the [Getting Started guide](https://guides.hanamirb.org/getting-started/).
## Donations
You can give back to Open Source, by supporting Hanami development via [GitHub Sponsors](https://github.com/sponsors/hanami).
## Contact
* [Home page](http://hanamirb.org)
* [Community](http://hanamirb.org/community)
* [Guides](https://guides.hanamirb.org)
* [Issues](https://github.com/hanami/hanami/issues)
* [Forum](https://discourse.hanamirb.org)
* [Chat](https://discord.gg/KFCxDmk3JQ)## Community
We care about building a friendly, inclusive and helpful community. We welcome people of all backgrounds, genders and experience levels, and respect you all equally.
We do not tolerate nazis, transphobes, racists, or any kind of bigotry. See our [code of conduct](http://hanamirb.org/community/#code-of-conduct) for more.
## 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 RequestIn 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](https://www.codetriage.com/hanami/hanami).
### Tests
To run all test suite:
```shell
$ bundle exec rake
```To run all the unit tests:
```shell
$ bundle exec rspec spec/unit
```To run all the integration tests:
```shell
$ bundle exec rspec spec/integration
```To run a single test:
```shell
$ bundle exec rspec path/to/spec.rb
```### Development Requirements
* Ruby >= 3.1
* Bundler
* Node.js## Versioning
Hanami uses [Semantic Versioning 2.0.0](http://semver.org).
## Copyright
Copyright © 2014–2024 Hanami Team – Released under MIT License.