2020-09-22 03:25:50 +02:00
# Contributing
...is welcome!
## Issue tracking / Repository
From issues to wikis: everything is on [GitHub ](https://github.com/krawieck/lemmur )
2021-02-19 23:23:23 +01:00
## Linting / Formatting
Everything is formatted with `dartfmt` (no flags) and linted with `dartanalyzer` ([see rules](analysis_options.yaml)). Both are enforced by the CI.
## Translations
<!-- TODO -->
2020-09-22 03:25:50 +02:00
## Architecture
Lemmur is written in Dart using [Flutter ](https://flutter.dev/docs ). To communicate with Lemmy instances [lemmy_api_client ](https://github.com/krawieck/lemmy_api_client ) is used.
### State management
2020-10-28 00:00:08 +01:00
`ChangeNotifier` + [Provider ](https://github.com/rrousselGit/provider ) is used for global state management, [flutter_hooks ](https://github.com/rrousselGit/flutter_hooks ) is used for local (widget-level) state management. `StatefulWidget` s are avoided all together and any state logic reuse is moved to a [custom hook ](./lib/hooks ).
2020-09-22 03:25:50 +02:00
### Project structure
(relative to `lib/` )
- `hooks/` : reusable state hooks
2021-02-19 23:23:23 +01:00
- `l10n/` : files with localized strings and localizations tools
2020-09-22 03:25:50 +02:00
- `pages/` : fullscreen pages that you navigate to
2020-10-28 00:00:08 +01:00
- `stores/` : global stores
2020-09-24 01:18:13 +02:00
- `util/` : utilities
2020-09-22 03:25:50 +02:00
- `widgets/` : reusable widgets; building blocks for pages
- `main.dart` : entrypoint of the app. Sets up the stores, initializes the themes, renders the first page
### Things to keep in mind
- Be aware that Lemmur supports arbitrary Lemmy instances, don't hardcode instance urls
- Remember that a user is not obligated to be logged in, contributed widgets should handle this case
2021-02-19 23:23:23 +01:00
### For React developers
2020-09-22 03:25:50 +02:00
2021-02-19 23:23:23 +01:00
If you come from a React background Flutter shouldn't be anything hard to grasp for you.
- Components are called 'widgets' in flutter
- `flutter_hooks` is a React hooks port to flutter. Though you will come to see that `flutter_hooks` are not as powerful
- There is no CSS. You compose your layout with other widgets and style them by passing properties to them
- There are no functional components, everything has to be a class
- Creating wrapping widgets is not as nice as in React, there is no `{ ...props }` . In flutter you need to pass each argument one by one
