search

fyne-io / defyne

The Fyne IDE
Other
197 stars 26 forks source link

Please add documentation of the app architecture #16

Open joeblew99 opened 2 years ago

joeblew99 commented 2 years ago

Defyne is actually usable... Great stuff !

Can you add some test projects ?

It would make it easier to experiment and also for me and others to help. Maybe a "ProjectTests" folder in the repo for now ?

I got some various widgets working and understand how the system fundamentally works. Seems to maintain a json description and then gen the golang from that json. It would be nice if a basic docs folder explained this, again so that others can help.

I am curious that is the architectural plan to add logic. For example click a button and change some text.

andydotxyz commented 2 years ago

I'm not clear what the purpose of a test project would be - is it for unit testing or for demonstrations? You can create a complete project which could be use for testing just by adding a project in the dialog that pops up on first use if you don't specify a parameter on open.

I am curious that is the architectural plan to add logic. For example click a button and change some text.

Not sure I understand sorry... At the moment you can click a button in the GUI editor and change the text in the properties panel - is this what you mean?

joeblew99 commented 2 years ago

Yeah i managed to create a test project in the way you said. I then opened a traditional IDE, to see how defyne works, watching it generate the golang code, and then noticed that quite a few of the controls dont work yet.

But its really a start and a very simple architecture that looks like its easy to extend to get the other controls working.

My main reason for opening the issue is to get feedback on what needs to be done to get the other controls working. So maybe examples are not appropriate... Maybe instead just some docs about how it works and what are the next steps would be useful to give me and others a roadmap on getting more controls working.

andydotxyz commented 2 years ago

But its really a start and a very simple architecture that looks like its easy to extend to get the other controls working.

Cool. Yeah the documentation is lacking because it's so early. If you can ask more specific questions then I can answer them :). Consider asking on the Fyne Slack or Discord channels so we can discuss more easily.

joeblew99 commented 2 years ago

no worries.. I asked on slack.

andydotxyz commented 2 years ago

OK thanks. Should we rename or refocus this issue, or close it?

joeblew99 commented 2 years ago

I think refocus it . It feels like its basically a matter of writing some markdown docs to explain a little bit about the basis of how this works and how to get other widgets working with it, so others can contribute.

andydotxyz commented 2 years ago

how to get other widgets working with it

Can you expand on this point, updating issue details etc appropriately? I am not clear on what widgets are not working on what needs added, so It's pretty tough to figure where to start on the docs.

joeblew99 commented 2 years ago

I tried a few basic widgets and they worked. I cant remember the ones that did not work - sorry.

The docs as i keep saying are the issue, because i ( and others ) dont have docs that explain it enough to see how to work on the widgets that dont work.