37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
# CookIt
|
|
|
|
A personal recipe collection for Android, built with Flutter. Meal planning, Cooking Mode, QR sharing and AI import come later; see [instructions.md](instructions.md).
|
|
|
|
- Vocabulary: [GLOSSARY.md](GLOSSARY.md)
|
|
- Decisions: [docs/adr/](docs/adr/)
|
|
- Recipe Bundle (import/export) format: [docs/recipe-bundle-format.md](docs/recipe-bundle-format.md)
|
|
- One-time Excel converter: [tools/excel-import/](tools/excel-import/)
|
|
|
|
## Develop
|
|
|
|
```sh
|
|
flutter pub get
|
|
dart run build_runner build # after changing drift tables (lib/src/database)
|
|
flutter gen-l10n # after changing lib/src/localization/app_de.arb
|
|
flutter analyze
|
|
flutter test
|
|
flutter run
|
|
```
|
|
|
|
On Windows, the database tests use the system's `winsqlite3.dll`. Set `COOKIT_SQLITE_DLL` to use a different SQLite library.
|
|
|
|
`test/bundle/bundle_service_test.dart` also imports the real converted workbook (`tools/excel-import/out/cookit-rezepte.zip`) when it exists.
|
|
|
|
## Layout
|
|
|
|
```
|
|
lib/src/
|
|
app.dart MaterialApp, routes
|
|
design/ theme (seed #65A86C, Nunito headings)
|
|
localization/ app_de.arb + generated code
|
|
database/ drift tables
|
|
recipes/ models, repositories, search, edit-form draft, views
|
|
bundle/ Recipe Bundle import/export
|
|
settings/ settings and Course list
|
|
```
|