ardrive-web

KO | EN

gitlite — search

#python #android #php #javascript #java #deep-learning #machine-learning #docker #kubernetes #golang #cli #python3

★ 71 Open GitHub ↗

Store files permanently on Arweave from your browser. Pay once, keep forever, with client-side encrypted private drives and links you can share with anyone.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ArDrive Web

![deploy](https://github.com/ardriveapp/ardrive-web/workflows/deploy/badge.svg)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](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.

ardrive-web

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README