Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ardriveapp/ardrive-web
The ArDrive App allows a user to log in to securely view, upload and manage their ArDrive files with their browser or mobile phone.
https://github.com/ardriveapp/ardrive-web
arweave dart flutter
Last synced: 3 days ago
JSON representation
The ArDrive App allows a user to log in to securely view, upload and manage their ArDrive files with their browser or mobile phone.
- Host: GitHub
- URL: https://github.com/ardriveapp/ardrive-web
- Owner: ardriveapp
- License: apache-2.0
- Created: 2020-07-07T13:53:20.000Z (over 4 years ago)
- Default Branch: dev
- Last Pushed: 2024-10-29T12:09:19.000Z (10 days ago)
- Last Synced: 2024-10-29T12:13:02.440Z (10 days ago)
- Topics: arweave, dart, flutter
- Language: Dart
- Homepage: https://app.ardrive.io
- Size: 489 MB
- Stars: 58
- Watchers: 7
- Forks: 19
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ArDrive Web
[](https://github.com/ardriveapp/ardrive-web/issues)
The ArDrive Web App allows a user to log in to securely view, upload and manage their ArDrive files.
Have any questions? Join the ArDrive Discord channel for support, news and updates. https://discord.gg/ya4hf2H
## Setting up the Development Environment
****
Install lefthook for your platform from the intructions [here](https://github.com/evilmartians/lefthook/blob/master/docs/other.md).
This will enable the use of git hooks.
After installing lefthook you need to enable it by running:
```shell
lefthook install
```
If your environment is using homebrew, install the Flutter SDK with its cask as shown below. Alternatively, visit the [Flutter Installation Instructions](https://flutter.dev/docs/get-started/install) to get the Flutter SDK up and running for your OS / local setup.
```shell
# with homebrew
brew install --cask flutter
```
Then, generate the package imports with:
```shell
flutter pub get
```
Install script runner to have access to pubspec scripts
```
flutter pub global activate script_runner
```
Make sure to add scr to your path with ``export``
In order to run them we need to use ``scr`` plus a ``pubspec.yaml`` script
e.g.to ``check-flutter`` script which checks if we re using the right Flutter version
```
scr check-flutter
```
Whenever changing branches or initially setting up, compile the codebase to resolve errors:
```shell
flutter pub run build_runner build --delete-conflicting-outputs
```
Then, to begin code generation and watch for changes, run:
```shell
flutter packages pub run build_runner watch
```
### App flavors
The app has three flavors: `development`, `staging` and `production`. To select one of those, follow the instructions for:
#### Web
```shell
flutter run -d chrome --dart-define=environment=development
```
To run using a production config, just remove the --dart-define argument
```shell
flutter run -d chrome
```
or
```shell
flutter run -d chrome --dart-define=environment=production
```
#### Mobile
```shell
flutter run --flavor=development
```
or
```shell
flutter run --flavor=production
```
All changes made to `dev` will be continuously deployed to [staging.ardrive.io](https://staging.ardrive.io). All PRs from this repo merging into `dev` will trigger a preview build that can be shared freely.
## Release
To create a release to [app.ardrive.io](https://app.ardrive.io), first merge any changes from `dev` into `master` that are required, and publish a new release through the GitHub UI with the tag name matching the pattern `v*` eg. `v1.0.1`.
This will trigger a GitHub Action that will deploy `master` to production.
## Using a custom Arweave Gateway URL
You can use a custom gateway URL by setting the `flutter.arweaveGatewayUrl` key in your browser's Local Storage.
With the web app opened you can access the browser's JavaScript console to run the follow examples:
```js
// To set the item. Note that the custom gateway value MUST be wrapped in double quotes
localStorage.setItem('flutter.arweaveGatewayUrl', '"https://my.custom.url"');
// To remove it (set the default)
localStorage.removeItem('flutter.arweaveGatewayUrl');
```
You may need to reload to apply the change.