Add README and LICENSE
This commit is contained in:
81
README.md
81
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
|
||||
|
||||
| | | | |
|
||||
|:---:|:---:|:---:|:---:|
|
||||
|  |  |  |  |
|
||||
|
||||
## 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)
|
||||
|
||||
Reference in New Issue
Block a user