Skip to content

yjukaku/hanami

 
 

Repository files navigation

Hanami

The web, with simplicity.

Frameworks

Hanami combines small yet powerful frameworks:

These components are designed to be used independently or together in a Hanami application. If you aren't familiar with them, please take time to go through their READMEs.

Donations

You can give back to Open Source, by supporting Hanami development via a donation. 💚

Supporters

Status

Gem Version Build Status Coverage Code Climate Dependencies Inline docs

Contact

Rubies

Hanami supports Ruby (MRI) 2.3+

Installation

% 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.

Community

We strive for a Community made of inclusive, helpful and smart people. 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

How To Use Hanami HEAD

If you want to test Hanami's HEAD to try a new feature or to test a bug fix, here's how to do:

git clone https://github.com/hanami/hanami.git
cd hanami && bundle
bundle exec hanami new --hanami-head=true bookshelf
cd bookshelf
vim Gemfile # edit with: gem 'hanami', path: '..'
bundle

Development Requirements

  • Ruby 2.3+ / JRuby 9.1.5.0+
  • Bundler
  • Qt (MacOS)
  • 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:

% ./script/setup
% bundle exec rspec spec/path/to/file_spec.rb

Build / CI

To run all the tests, please use:

% ./script/ci

Versioning

Hanami uses Semantic Versioning 2.0.0

Copyright

Copyright © 2014-2016 Luca Guidi – Released under MIT License This project was formerly known as Lotus (lotusrb).

About

The web, with simplicity.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 97.3%
  • HTML 2.3%
  • Shell 0.4%