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

List of all important guides #1

Open
davydovanton opened this issue Dec 20, 2016 · 5 comments
Open

List of all important guides #1

davydovanton opened this issue Dec 20, 2016 · 5 comments

Comments

@davydovanton
Copy link
Member

davydovanton commented Dec 20, 2016

I think we need to create the general issue with all parts which we want to cover.

What guides we need to create

  • How to login

    • omniauth (I have working code for this)
    • auth
  • slug

  • How to testing my app

    • testing (rspec-hanami, vcr, etc) (I have working code for this)
    • test DB cleaner
  • How to work with frontend

    • pagination
    • webpack (react or vue) (I have working code for this)
    • email preview (I have blog post for this)
  • How to upload files

  • How to work with NoSQL DB

  • How to organize my code

    • service object (I have working code for this)
    • presenters
    • trailblazer
    • dry-*
  • How to maintain server

    • logging
    • deploy
    • server monitoring
  • How to call code in background

    • sidekiq, resque
  • How to create JSON API

    • API documentation
    • JSON response
  • How to add realtime to my server

    • web sockets
  • How to create multi lang apps

    • i18n
  • state machine

  • A/B testing (?)

So, let's try to discuss this 😊

/cc @hanami/ecosystem

@davydovanton davydovanton changed the title List of all unnecessary guides List of all important guides Dec 20, 2016
@pascalbetz pascalbetz mentioned this issue Dec 20, 2016
@kzaitsev
Copy link

it would be good to have: Hanami for rails developers

@nickgnd
Copy link

nickgnd commented Dec 20, 2016

First off, thank you all for your work. I started to try Hanami last month and I really like it. 👏 👏

In addition to what has already been said, I think that would be very interesting an introduction of some "internal" parts of Hanami, something like "hanami under the hood" :)

Especially, I'm thinking about:

  • Hanami::Interactor: how and when to use, ... (I didn't find any guide about this)
  • hanami-model and integration with Rom.rb: how it works, how to use Rom.rb apis, ...

Thanks again!

@cllns
Copy link
Member

cllns commented Dec 20, 2016

@nickgnd thanks for your input! I'm planning on writing a guide for Hanami::Interactor soon :). I agree about adding a ROM guide.

@Bugagazavr I like the Hanami for Rails developers idea. I'd like to see that as a "tips" page, like how to mount a Hanami app inside a Rails app. I think the "Getting Started" guide should be good for all people, including Rails developers.

@rafaels88
Copy link

Not sure if this topic is implicit in any of those above, but some ideas about how to scale a monolithic app would be awesome. I mean, Hanami is incredible for start mono and became splitted, so some words about that would be great! ;)

@cllns
Copy link
Member

cllns commented Dec 21, 2016

@rafaels88 Splitting a monolith into parts might be outside the scope of Hanami docs, since it's not Hanami specific. It's also subjective, not easy, and specific to each project. Perhaps we could link to some outside resources, instead of writing our own?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants