From 1191d06e53dc20dadfb7bcf784a52121b474b025 Mon Sep 17 00:00:00 2001 From: Menno van Leeuwen Date: Wed, 27 Aug 2025 14:11:05 +0200 Subject: [PATCH] adds license and proper readme --- LICENSE | 21 +++++++++++++++ README.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++++------- 2 files changed, 88 insertions(+), 9 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f8e651f --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Menno van Leeuwen + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 7a20bb4..41140ab 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,74 @@ -# supplements +# Supplements Tracker -A new Flutter project. +A Flutter application designed to help you track your daily supplement intake, manage dosages, and set reminders. This app aims to provide a simple and intuitive way to stay on top of your supplement regimen. + +## Features + +- **Supplement Management**: Easily add, edit, and delete supplements, including details like name, dosage, and frequency. +- **Intake Tracking**: Log your daily supplement intake, marking when you've taken your doses. +- **Reminders**: Set up local notifications to remind you when it's time to take your supplements. +- **Customizable Theme**: Switch between light and dark themes to suit your preference. +- **Local Data Storage**: All your supplement data is stored locally on your device. + +## Technologies Used + +- **Flutter**: The UI toolkit used for building natively compiled applications for mobile, web, and desktop from a single codebase. +- **Provider**: A robust state management solution for Flutter applications. +- **sqflite**: For efficient local database persistence using SQLite. +- **shared_preferences**: To persist user settings and preferences locally. +- **flutter_local_notifications**: For scheduling and displaying local notifications to remind you about dosages. +- **timezone**: Ensures accurate time zone handling for notification scheduling. +- **intl**: For internationalization and flexible date/time formatting. ## Getting Started -This project is a starting point for a Flutter application. +Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes. -A few resources to get you started if this is your first Flutter project: +### Prerequisites -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +Before you begin, ensure you have the following installed: -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +- **Flutter SDK**: Refer to the [official Flutter installation guide](https://flutter.dev/docs/get-started/install) for detailed instructions. +- An Integrated Development Environment (IDE) such as [VS Code](https://code.visualstudio.com/) with the Flutter extension, or [Android Studio](https://developer.android.com/studio). + +### Installation + +1. **Clone the repository**: + + ```bash + git clone https://github.com/vleeuwenmenno/supplements.git + cd supplements + ``` + +2. **Get dependencies**: + Navigate to the project directory and run: + ```bash + flutter pub get + ``` + +### Running the Application + +To run the application on a connected device or emulator: + +```bash +flutter run +``` + +To build a release version for a specific platform: + +- **Android APK**: + ```bash + flutter build apk --release + ``` +- **iOS (requires macOS and Xcode)**: + ```bash + flutter build ios --release + ``` + +## Contributing + +Contributions are welcome! If you have suggestions for improvements or new features, please feel free to open an issue or submit a pull request. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.