re-frame cookbook - Githubissues

smahood commented 9 years ago

Would it be possible to start a re-frame cookbook, similar to the ones for reagent and om?

gadfly361 commented 9 years ago

Just throwing it out there - any interest in including re-frame in reagent cookbook for consolidation? We could make a section for re-frame recipes and create its own minimal starting template. (especially given that this conversation is forming https://groups.google.com/forum/#!topic/reagent-project/NXYqJyCS4AE)

whodidthis commented 9 years ago

I think we should wait for Mike&Co.'s reusable re-frame components they have been working on to set up a baseline on what information they see being shared through dispatch and app-db, and what through props.

mike-thompson-day8 commented 9 years ago

@smahood On Cookbook:

Was there anything in particular you were interested in seeing in a re-frame cookbook?
I am trying to consolidate all the relevant material into the Wiki for the moment, so if there are recipes, I think I'd like to seem them start life as a Wiki page, while we work this out. Feel free to add a page, if you think there is something that should be there. And, sure, there's every chance these pages might work their way across into the Reagent cookbook, but they have to be identified and written first.

Writing this sort of material is the hard part. Putting it somewhere is easy.

@whodidthis I'd like to manage expectations regarding re-com (a components library):

come hell or high water, we'll release it next week. It has taken us a very long time to make it fit for public consumption. I sure hope we get some payback :-)
re-com is not re-frame specific. The components are simply a layer over regent. They will exist in their own repo. (But they do dovetail well with re-frame).
re-com isn't complete. It is still missing a couple of controls, like a tree.
re-com makes heavy use of flexbox and has only been tested on webkit. In theory re-com components should work on all modern browsers, but that's not been our focus because we don't need it. If you are developing for the retail web, re-com's use of flexbox will be a problem because IE 9 and IE 10 don't have flexbox.

Unless you can mandate your user's browser (enterprise app? atom shell based?) then re-com might not be that useful to you. But it might be an ideas generator and/or provide a source of copy 'n paste code.

smahood commented 9 years ago

@mike-thompson-day8 I'll take a look and see if I can see anything I can suggest or work on.

mike-thompson-day8 commented 9 years ago

@smahood Thanks!

gadfly361 commented 9 years ago

@mike-thompson-day8 Regarding the comment:

I am trying to consolidate all the relevant material into the Wiki for the moment, so if there are recipes, I think I'd like to seem them start life as a Wiki page, while we work this out. Feel free to add a page, if you think there is something that should be there. And, sure, there's every chance these pages might work their way across into the Reagent cookbook, but they have to be identified and written first.

What are your thoughts about having examples in existence somewhere (doesn't have to be in RC) that serve only as a reference implementation of re-frame (i.e., examples that don't warrant a wiki page / discussion).

For instance, consider this recipe (which is on a branch of RC and will be removed) ... it would make a lousy wiki page, but it might be useful for someone just wanting to see another example of re-frame in action.

postspectacular commented 9 years ago

FWIW I just uploaded an example component (FPS canvas visualization) using a slightly refactored tick handler setup (as described here on the wiki):

https://gist.github.com/postspectacular/90f27d819b3364eda0ab

mike-thompson-day8 commented 9 years ago

First, in case anyone missed it on the newsgroup, re-com is released: https://github.com/Day8/re-com

@gadfly361 Yeah, it will stifle things a bit to insist everything be in the Wiki. I'll continue to put my efforts into the Wiki, but that sort of recipe in the RC looks beneficial, so yeah go for it. BTW, on the subject covered in the recipe note the information in this thread

@postspectacular Perhaps we need an "Examples" page in the Wiki and then everyone can add their links and descriptions in there. I'll do that now.

mike-thompson-day8 commented 9 years ago

Have added: https://github.com/Day8/re-frame/wiki/External-Resources

Please add to it as you see fit.

gadfly361 commented 9 years ago

@mike-thompson-day8 re-com is awesome!! (I updated reagent-seed template to use re-frame and re-com.)

Also, I think the external resources page is a great idea :)

mike-thompson-day8 commented 9 years ago

I'm going to close this. If you have external links to add, please put them in: https://github.com/Day8/re-frame/wiki/External-Resources

day8 / re-frame

re-frame cookbook #38