Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add list of guides to write #3

Closed
wants to merge 6 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,77 @@ We strive to make Hanami a good Ruby citizen.

This means we want to ensure common libraries work well with Hanami,
*and* it also means that we want to ensure that Hanami works well with others too!

## Guides to write and publish
### Authentication
- [ ] `warden`
- [ ] [`rodauth`](https://github.com/davydovanton/hanami-rodauth) (@davydovanton)
- [ ] `omniauth` (@davydovanton)

### Authorization
- [ ] `cancancan`
- [ ] `pundit`? (depends on ActiveSupport)
- [ ] `authority`? (depends on ActiveSupport)

### Testing
- [ ] [`rspec-hanami`](https://github.com/davydovanton/rspec-hanami) (@davydovanton)
- [ ] `vcr` (@davydovanton)
- [ ] `webmock`
- [ ] `database_cleaner`

### API's
- [ ] API documentation
- [ ] JSON responses
- [ ] [`jbuilder`](https://github.com/vladfaust/hanami-jbuilder)
- [ ] `roar`
- [ ] [JSON API™](https://github.com/jsonapi-rb/jsonapi-hanami) (@beauby)

### File Uploads
- [ ] AWS S3, directly (@beauby)
- [ ] shrine (https://github.com/katafrakt/hanami-shrine)

### Assets
- [ ] hanami-assets (including limitations)
- [ ] webpack (@davydovanton)
- [ ] [bootstrap](https://github.com/davydovanton/hanami-bootstrap) (@davydovanton)
- [ ] front-end frameworks, mention by name React, Ember, Angular, Elm, Vue, etc. (@davydovanton)

### Server hosting
- [ ] logging
- [ ] deploying
- [ ] Heroku
- [ ] Capistrano?
- [ ] server monitoring

### Background jobs
- [ ] `sidekiq`
- [ ] `resque`

### Multiple language support
- [ ] `i18n`

### Rack-compatibility
- [ ] Mounting Hanami into other Rack-compatible frameworks
- [ ] Mounting other Rack-compatible frameworks into Hanami

### Architecture tips
- [ ] `Hanami::Interactor` (@davydovanton & @cllns)
- [ ] `Hanami::Presenter`
- [ ] Trailblazer (@apotonick?)
- [ ] `dry-rb` libraries

### Real-time web
- [ ] web sockets

### Alternative ORM's
- [ ] `rom` (directly)
- [ ] `sequel`?
- [ ] `mongoid`?

### Others
- [ ] email preview (@davydovanton)
- [ ] URL slugs
- [ ] pagination
- [ ] state machines (@davydovanton?)
- [ ] request throttling (rack-attack?)
- [ ] A/B testing?