{"id":23185070,"url":"https://github.com/do-ko/waste_not","last_synced_at":"2025-10-07T07:32:09.529Z","repository":{"id":246592379,"uuid":"787807441","full_name":"do-ko/waste_not","owner":"do-ko","description":"WasteNot is an application to manage products in the fridge by their expiration dates","archived":false,"fork":false,"pushed_at":"2024-06-20T07:42:06.000Z","size":604,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-10T12:25:50.798Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/do-ko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-17T08:13:02.000Z","updated_at":"2024-06-28T20:37:13.000Z","dependencies_parsed_at":"2024-06-28T22:40:59.657Z","dependency_job_id":"6d85242f-88e1-4394-a116-bbc7ad09e68d","html_url":"https://github.com/do-ko/waste_not","commit_stats":null,"previous_names":["do-ko/waste_not"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/do-ko%2Fwaste_not","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/do-ko%2Fwaste_not/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/do-ko%2Fwaste_not/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/do-ko%2Fwaste_not/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/do-ko","download_url":"https://codeload.github.com/do-ko/waste_not/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247287404,"owners_count":20914153,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-18T09:26:16.484Z","updated_at":"2025-10-07T07:32:04.487Z","avatar_url":"https://github.com/do-ko.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Documentation\n\n**Project name:** WasteNot\n\n**Topic:** Easy-to-use application meant to help users keep track of the contents of their fridge and pantry and avoid wasting food.\n\n**Details:** Mobile client-server application, implementing the Model-View-Controller schema.\n\n**Technologies in use:**\n\n- \u003cspan style=\"text-decoration:underline;\"\u003eFrontend:\u003c/span\u003e Flutter, using Dart language\n- \u003cspan style=\"text-decoration:underline;\"\u003eBackend:\u003c/span\u003e Firebase\n  - Firebase Authentication - authentication service\n  - Firebase Firestore - document database\n  - Firebase Storage - file storage, used for images\n- \u003cspan style=\"text-decoration:underline;\"\u003eDevelopment IDE:\u003c/span\u003e Android Studio, IntelliJ and VS Code\n- \u003cspan style=\"text-decoration:underline;\"\u003eVersion control:\u003c/span\u003e GitHub\n- \u003cspan style=\"text-decoration:underline;\"\u003eTesting tools:\u003c/span\u003e x,y,z packages used for testing\n\n**Project structure:**\n\n- android - configuration and build files for Android version of the app, auto-generated\n- ios - configuration and build files for iOS version of the app, auto-generated\n- web - configuration and build files for Web version of the app, auto-generated\n- windows - configuration and build files for Windows version of the app, auto-generated\n- linux - configuration and build files for Linux version of the app, auto-generated\n- macos - configuration and build files for MacOS version of the app, auto-generated\n\n- firebase.json - Firebase configuration data\n- pubspec.yaml - Flutter package configuration\n\n- **\u003cspan style=\"text-decoration:underline;\"\u003eassets - assets to be folded into the application executable on build\u003c/span\u003e**\n  - [category name].svg - vector icons for product categories\n  - placeholder.svg - vector version of placeholder image for missing images\n  - placeholder_product_image.jpg - placeholder image for a missing image in Product views\n  - jingle_short.mp3 - sound file used on sign-in and adding product\n- **\u003cspan style=\"text-decoration:underline;\"\u003eintegration_test - source code and data for integration tests, specifically\u003c/span\u003e**\n\n  - auth_test.dart - source code for the registration and login tests\n\n- **\u003cspan style=\"text-decoration:underline;\"\u003elib - source code for the application\u003c/span\u003e**\n  - controllers - definitions of controllers\n    - model_controllers - controllers holding and manipulating model state\n      - category.dart - controller for categories\n      - product.dart - controller for a single product\n      - products.dart - controller for all user’s products\n      - user.dart - controller for the current user\n    - page_controllers - controllers for behavior of each view\n      - [view name].dart - controller holding and manipulating the state of a particular view\n    - shared - controllers used in more than one view\n      - add_or_edit_product.dart - common controller for AddProduct and EditProduct forms\n      - auth.dart - controller for authentication state and account settings\n      - sound.dart - controller for playing sound\n      - validator.dart - common controller for account editing and authentication forms\n  - models - definitions of model entities\n    - category.dart - model of the Category entity\n    - product.dart - model of the Product entity\n    - user.dart - model of the User entity\n  - view - widget definitions\n    - [view name].dart - widgets for each view\n    - shared - smaller widgets and widgets common across many views\n      - [name].dart - definition of a single widget\n  - firebase_options.dart - default configuration of the connection to Firebase, taken as-is from the Firebase console\n  - **main.dart**- entrypoint of the application, WasteNotApp widget declaration\n- **\u003cspan style=\"text-decoration:underline;\"\u003etest - source code and data for tests\u003c/span\u003e**\n  - home_view_test.dart - testing of HomeView UI component\n  - product_model_test.dart - testing of Product model class\n  - user_model_test.dart - testing of User model class\n\n**Installation:**\n\n- \u003cspan style=\"text-decoration:underline;\"\u003eUsing Android Studio:\u003c/span\u003e\n  - Connect your device to the computer\n  - Turn on USB debugging mode\n  - Ensure that Android Studio sees your device\n  - Pick the device you connected as compilation target\n  - Build and run the release version\n  - The application should show up in your device apps now, even after disconnecting the device\n- \u003cspan style=\"text-decoration:underline;\"\u003eAndroid installation using APK file:\u003c/span\u003e\n  - Execute **flutter build apk** command in the main project folder\n  - Transfer the created apk to the target device\n  - Click on the file and confirm installation when prompted\n  - The application should show up in your device apps now\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdo-ko%2Fwaste_not","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdo-ko%2Fwaste_not","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdo-ko%2Fwaste_not/lists"}