diff --git a/.meta/1.png b/.meta/1.png new file mode 100644 index 0000000..66bd34a Binary files /dev/null and b/.meta/1.png differ diff --git a/.meta/2.png b/.meta/2.png new file mode 100644 index 0000000..5ff45dc Binary files /dev/null and b/.meta/2.png differ diff --git a/.meta/3.png b/.meta/3.png new file mode 100644 index 0000000..de730fe Binary files /dev/null and b/.meta/3.png differ diff --git a/.meta/4.png b/.meta/4.png new file mode 100644 index 0000000..19efbd3 Binary files /dev/null and b/.meta/4.png differ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..927cdf7 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,23 @@ +# License + +COPYRIGHT AND PERMISSION NOTICE + +Copyright (c) 2026, Bearologics GmbH, and contributors. + +All rights reserved. + +Permission to use, copy, modify, and distribute this software for any purpose +with or without fee is hereby granted, provided that the above copyright notice +and this permission notice appear in all copies. + +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 OF THIRD PARTY RIGHTS. +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. + +Except as contained in this notice, the name of a copyright holder shall not +be used in advertising or otherwise to promote the sale, use or other dealings +in this Software without prior written authorization of the copyright holder. diff --git a/README.md b/README.md index 6fd1124..04da133 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,79 @@ -# bmmanager +# BrandManager -A new Flutter project. +Your DMR network, simplified. + +BrandManager is a mobile application for managing your [BrandMeister](https://brandmeister.network) DMR network devices. Built with Flutter, it provides a clean and intuitive interface to monitor and control your hotspots and repeaters. + +## Features + +- **Device Management** - View and manage all your registered BrandMeister devices +- **Last Activity** - Monitor recent network activity with real-time updates +- **Secure Authentication** - API tokens are stored securely in encrypted storage on your device + +## Screenshots + +| | | | | +|:---:|:---:|:---:|:---:| +| ![Screenshot 1](.meta/1.png) | ![Screenshot 2](.meta/2.png) | ![Screenshot 3](.meta/3.png) | ![Screenshot 4](.meta/4.png) | ## Getting Started -This project is a starting point for a Flutter application. +### Prerequisites -A few resources to get you started if this is your first Flutter project: +- Flutter SDK 3.10.7 or later +- A BrandMeister account with an API token -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) +### Installation -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. +1. Clone the repository: + ```bash + git clone https://git.bearologics.org/Bearologics/BrandManager.git + cd BrandManager + ``` + +2. Install dependencies: + ```bash + flutter pub get + ``` + +3. Run the app: + ```bash + flutter run + ``` + +### Getting Your API Token + +1. Log in to your [BrandMeister account](https://brandmeister.network) +2. Navigate to your profile settings +3. Generate an API token from the API section + +## Building + +### iOS +```bash +flutter build ios +``` + +### Android +```bash +flutter build apk +``` + +### macOS +```bash +flutter build macos +``` + +## License + +This project is licensed under a curl-style license - see the [LICENSE.md](LICENSE.md) file for details. + +## Author + +Bearologics GmbH + +## Links + +- [BrandMeister Network](https://brandmeister.network) +- [Impressum](https://bearologics.com/impressum) +- [Privacy Policy](https://bearologics.com/privacy)