Butterfly/app/README.md

Butterfly App

Read more here

Technology

This app was build using flutter. Read more about here. For generating the *.g.dart and *.freezed.dart files use the flutter pub run build_runner build command.

Structure

The code for this app is stored in the lib directory.

lib
- actions
- api
- bloc
- cubits
- dialogs
- embed
- handlers
- helpers
- l10n
- models
- services
- settings
- views
- visualizer
- widgets

• The actions directory has all shortcuts that can be used in the app.
• The api directory stores useful functions for the app. Some functions are separated between html (web) and io (native platforms).
• The bloc directory stores the save system of the app. In the document_bloc.dart file, you can see all handlers to the events that are defined in the api/protocol/event.dart file. The document_state.dart file stores all states that the app can have.
• The cubits directory stores small state systems that are not necessarily associated with the document. Here you also find the position and settings states.
• The dialogs directory stores all ui for the dialogs that can be opened in the app. For example the file system dialog or the open dialog.
• The embed directory handles all events required for the embedding mode.
• The handlers directory stores all gesture handlers for the tools. Here it is defined that for example the PenTool creates a PenElement when the user starts drawing.
• The helpers directory stores all helper functions (extensions) that simplify the usage of base classes, like the Rect class.
• The l10n directory stores all the strings and translations that are used in the app. Please only edit the app_en.arb file, the other files gets updated by Crowdin.
• The models directory stores all app specific models that are not general to be added in the api directory.
• The services directory defines all services that runs in the background while using the app.
• The settings directory stores all the settings pages ui that are used in the app.
• The views directory stores all the ui views that are used in the document page. For example the appbar, the toolbar or the main view.
• The visualizer directory are helper methods that stores all converters between the models and the ui.
• The widgets directory stores all general widget that can be reused inside the app. For example the context menu.

Rebuilding assets

To rebuild the splash screen use:

flutter pub run flutter_native_splash:create --path flutter_native_splash-production.yaml