Skip to content
This repository has been archived by the owner on Dec 21, 2024. It is now read-only.

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
lewislarsen committed Aug 13, 2024
1 parent e6c40aa commit 87a3b09
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 8 deletions.
7 changes: 2 additions & 5 deletions .github/workflows/flutter_test.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Flutter Test
name: Flutter Tests

on:
workflow_call:
Expand All @@ -17,11 +17,8 @@ jobs:
- name: Install dependencies
run: flutter pub get

- name: Analyze project source
run: flutter analyze

- name: Generate mocks
run: flutter pub run build_runner build --delete-conflicting-outputs
run: dart run build_runner build --delete-conflicting-outputs

- name: Run unit tests
run: flutter test
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) [2024] [Lewis Larsen]

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.
61 changes: 58 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,60 @@
## Mobile App
# Vanguard Mobile

This is the mobile application for Vanguard.
## Overview

Currently very barebones, no tests yet and limited functionality.
The Vanguard Mobile app is your essential companion for managing and interacting with your Vanguard backup system. With this app, you can monitor your backups, manage your account, and ensure your data is always secure, all from the convenience of your mobile device.

For more detailed information about the mobile app's features and functionalities, please visit our [website](https://vanguardbackup.com) and refer to the [official documentation](https://docs.vanguardbackup.com/mobile-app).

## Features
- **Run Tasks**: Run Backup Tasks from the application.
- **Real-time Monitoring**: Keep track of your backup status in real-time.
- **Account Management**: Easily access and manage your Vanguard account.

## Screenshots

![Vanguard Mobile Screenshot](/screenshots/phone-render.png)

## Installation

The Vanguard Mobile app is built with Flutter, ensuring a smooth and responsive experience across both Android and iOS platforms. Follow the instructions below to install the app on your device:

1. **Android**: Download from the [Google Play Store](#).
2. **iOS**: Download from the [App Store](#).

## Development Setup

If you are interested in contributing or customizing the Vanguard Mobile app, follow these steps to set up the project for development:

1. **Clone the Repository**:
```bash
git clone https://github.com/vanguardbackup/vanguard-mobile.git
cd vanguard-mobile
```

2. **Install Dependencies**:
Ensure you have Flutter installed. Then, install the required dependencies:
```bash
flutter pub get
```

3. **Run the App**:
To run the app on an emulator or connected device, use the following command:
```bash
flutter run
```

4. **Build for Production**:
To build the app for production, run:
```bash
flutter build apk # For Android
flutter build ios # For iOS
```

## License

The Vanguard Mobile app is licensed under the [MIT License](https://github.com/vanguardbackup/mobile/blob/main/LICENSE), giving you the freedom to use, modify, and distribute the app as needed.

## Security Disclosure

If you discover any security vulnerabilities, please follow our [Security Disclosure Policy](https://github.com/vanguardbackup/vanguard/security/policy) to report them. We take security seriously and appreciate your help in keeping Vanguard Mobile secure.
Binary file added screenshots/phone-render.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 87a3b09

Please sign in to comment.