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

Purpose of gallerize package #1

Open
WieFel opened this issue Oct 6, 2020 · 12 comments
Open

Purpose of gallerize package #1

WieFel opened this issue Oct 6, 2020 · 12 comments
Labels
good first issue Good for newcomers

Comments

@WieFel
Copy link
Owner

WieFel commented Oct 6, 2020

Time to spin-off the components of demo app that could be reused by other package maintainer to build similar "demo" app.

Here are some pointers/questions about it:

  • What should we call it? - demo_maker, demoize, gallerize, or something else (suggest in comment)
  • @WieFel I suggest you be the primary maintainer of the project and repo.
  • Some feature still needs to be implemented to make it like gallery app - having toggle for fullscreen/mobile view. Although this is non-blocking, could be implemented in future.
  • The proposed package should also be submitted to fluttercommunity org.
  • backdrop - should use the planned package for it's demo app.

Taken over issue fluttercommunity/backdrop#62 (comment) by @daadu

This issue should be a starting point where I will list the basic features of the package and it's structure. Of course, anything is open for discussion.

@daadu
Copy link
Collaborator

daadu commented Oct 6, 2020

Firstly, please reserve the name on pub.dev with blank project

@WieFel
Copy link
Owner Author

WieFel commented Oct 15, 2020

Package overview

The general idea would be to take the structure already used in https://github.com/fluttercommunity/backdrop/tree/master/demo/lib/demo:

  • GallerizePage as the main widget which can be used to create a demo app.
  • GallerizePage is further structured into three "tabs" GallerizeInfo, GallerizePreview and GallerizeCode.
  • GallerizePage has the following properties:
    • title: title (string) to be displayed within Info. (could be replaced by customizable Widget)
    • description: description (string) to be displayed within Info. (could be replaced by customizable Widget)
    • codeFile: path to the .dart file containing the code to be shown in the Code tab.
    • preview: widget to be displayed within the Preview tab.
    • highlightingTheme: the syntax highlighting theme for the code, defaults to dracula.

Furthermore:

  • the two themes (light+dark) used within the Flutter Gallery app can be reused.

@daadu
Copy link
Collaborator

daadu commented Oct 15, 2020

I suggest going with Gallery or Gallerize prefix for widgets.

@WieFel
Copy link
Owner Author

WieFel commented Oct 15, 2020

I suggest going with Gallery or Gallerize prefix for widgets.

Oh, you're right :D didn't think about that...

@WieFel
Copy link
Owner Author

WieFel commented Nov 10, 2020

@daadu what do you think of readme.md?
I think the package will soon be ready for first release. What do you think?

@daadu
Copy link
Collaborator

daadu commented Nov 11, 2020

LGTM.

More section (suggestion) in README:

  • TODO
  • Contribution Guideline

More guide/feature in README (add in TODO, if not figured out yet):

  • Github Pages + Github Action Setup - to host the gallery, with CD - any push to master branch triggers flutter build web -> commit/createPR to gh-pages branch -> changes reflected to "Github Pages"
  • Add "Gallery" Shield - which users can put in their README

@daadu
Copy link
Collaborator

daadu commented Nov 11, 2020

I suggest using "Flutter package for creating Flutter Gallery like gallery/demo for your package/widget." as short description instead of "Flutter package for creating a gallery (demo) of your package/widget.".

@daadu
Copy link
Collaborator

daadu commented Nov 11, 2020

Add "multi-screen size support" in TODO

@WieFel
Copy link
Owner Author

WieFel commented Nov 11, 2020

Add "multi-screen size support" in TODO

with this you mean "toggle for fullscreen/mobile view", right @daadu ?

@daadu
Copy link
Collaborator

daadu commented Nov 12, 2020

Add "multi-screen size support" in TODO

with this you mean "toggle for fullscreen/mobile view", right @daadu ?

yes

@WieFel
Copy link
Owner Author

WieFel commented Nov 12, 2020

@daadu just created package proposal for fluttercommunity: fluttercommunity/community#60

@daadu
Copy link
Collaborator

daadu commented Nov 12, 2020

@WieFel Images are not loading on pub.dev

@WieFel WieFel added the good first issue Good for newcomers label Dec 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants