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

Split refactoring for Geppetto Lean applications #174

Open
filippomc opened this issue Jan 31, 2020 · 1 comment
Open

Split refactoring for Geppetto Lean applications #174

filippomc opened this issue Jan 31, 2020 · 1 comment
Assignees
Labels
breaking change enhancement New feature or request

Comments

@filippomc
Copy link
Contributor

filippomc commented Jan 31, 2020

The purpose of this refactoring is to extract the parts of Geppetto that can be useful to build "lean" Geppetto applications. A Geppetto lean application can use the Geppetto Model and UI components without necessarily having a full Geppetto backend behind (see image)

Geppetto enable lean applications - Page 1

In order for that to be possible, a big refactoring is needed to remove all the dependencies in the control logic, starting from the ModelFactory. This refactoring of dependencies is also needed by #145

Also the component spring cleaning from #113 is part of this refactoring.
The plan is summarized here:
https://docs.google.com/spreadsheets/d/1qQgio7uKc41-h-VoebWW1_qj7Sai07VpiTjh5zu8o2Q/edit

@filippomc filippomc added enhancement New feature or request breaking change labels Jan 31, 2020
@filippomc filippomc self-assigned this Jan 31, 2020
@filippomc
Copy link
Contributor Author

filippomc commented Jan 31, 2020

Also, from #113:

  • Do an inventory of all components inside controls, widgets, interface. The goal is we need to qualify whether to remove or not each of the components which depends on code quality, usage and usefulness. The question we want to answer is: if we were to build a new geppetto application today is this a component that we would use or not? Track their usage (check geppetto-vfb, geppetto-osb, geppetto-application, geppetto-hm, geppetto-netpyne, geppetto-nwbexplorer), check last commit, check code quality (ES6? Full react? is jQuery used? is it used by the ComponentFactory?). For instance, we probably want to remove all controls since nowadays we can just rely on an external library to do the job, e.g. Material UI
  • Review the inventory, agree what we are going to remove.
  • Remove the components
  • Create a card to document all components that we have not removed on org.geppetto.docs
  • Create a card to create a showcase for the components that we have not removed (e.g. https://github.com/openworm/geppetto-client/blob/development/js/components/interface/listViewer/showcase/ListViewerShowcase.js)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant