Project

hanami-db

0.01
The project is in a healthy, maintained state
The database layer for Hanami apps
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

~> 2.6
~> 5.4, >= 5.4.1
~> 3.7
 Project Readme

Hanami DB Gem Version CI Status

Forum Chat

Installation

Add this line to your Hanami application's Gemfile:

gem "hanami-db"

And then execute:

$ bundle

Development

Most of the test suite runs against SQLite and needs no setup. The specs that exercise Postgres and MySQL need those servers running, which docker compose provides. This needs Docker installed: Docker Desktop on macOS and Windows, or Docker Engine with the Compose plugin on Linux.

$ docker compose up -d
$ bundle exec rspec

Locally, Postgres listens on 5433 and MySQL on 3307, so they don't collide with any servers you already have installed. CI runs Postgres on its default 5432 and MySQL on 3307. Override POSTGRES_BASE_URL if your setup differs.

Contributing

  1. Fork it
  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 new Pull Request

Links

License

See LICENSE file.