Skip to content

update readme docs #1007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: development
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 66 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,55 @@ It contains an ultra secure 2FA authenticator for authenticating through third p

Inside the app, you can manage your Threefold Tokens(TFT).

## Features
## Features

### Threefold news
### Wallet

Inside the app, there is a "News" section where you can find all the latest Threefold news!
In the ThreeFold Connect app, you can:

### Wallet
- Manage your ThreeFold Tokens (TFT) across multiple wallets
- Import existing wallets using seed phrases or secret keys
- Send and receive tokens on both TFChain and the Stellar network
- Bridge tokens between TFChain, Stellar and Solana networks
- Verify your identity for KYC requirements
- Monitor your balance in real-time
- Manage contacts for easy transfers

In the Threefold Connect app, it is possible to manage your TFT and view your transaction history on the TF chain.
### Farm

### Farmers
In the ThreeFold Connect app, you can:

If you own a Threefold node, you can manage your farm here.
- Create and manage both v3 and v4 farms
- View farm details and configurations
- Track node status (online/offline) in real-time

### Support
### Node Monitoring

If you have Threefold related questions, we provide a support chat where we will answer your questions as soon as possible!
- Receive proactive notifications when nodes go offline
- Smart notification system that categorizes offline nodes:
- Recent outages (0-1 hour): Notifications every 15 minutes
- Short outages (1-4 hours): Notifications every hour
- Medium outages (4-24 hours): Notifications every 4 hours
- Extended outages (1-3 days): Notifications every 12 hours
- Long outages (3-7 days): Notifications once daily
- Very long outages (beyond 7 days): Notifications suppressed

### DAO

Inside the app, you can vote on proposals and view the results of your votes.

### Threefold News

Inside the app, there is a "News" section where you can find all the latest Threefold news!

### Identity

When you are using the secure 2FA authentication, some third party apps require certain information (eg. phone number). In this tab you can verify your email, phone number and identity to provide this data to the third party application. This allows you total granular control over which data you choose to share or not share.

### Support

If you have Threefold related questions, we provide a support chat where we will answer your questions as soon as possible!

## New codebase

In June 2022, a new codebase has been written for this project. It is built on turborepository. This codebase is still in development and not ready yet, you can find this under v2 branch.
Expand Down Expand Up @@ -68,12 +94,38 @@ uwsgi --http :5000 --gevent 1000 --http-websockets --master --wsgi-file __main__

## App

Make sure you have at least Flutter 2.8.1 installed. If everything is installed properly, execute the following commands:
### Setup and Run the Mobile App

1. **Prerequisites**
- Install Flutter 3.27.2

2. **Configure the App**
- Navigate to the app directory: `cd app`
- Copy configuration templates:

```bash
dart run build_runner build
```

3. **Initialize the Environment**
- Run the initialization script:

```bash
./build.sh --init
```

- Switch to local development environment:

Copy the file in /lib/app_config_local.template into /lib/app_config_local.dart and change the configuration to your local IP's
```bash
./build.sh --switch --local
```

After that, use the build.sh script to set up the right environment
4. **Run the App**
- Connect your Android/iOS device or start an emulator
- Launch the app:

`./build.sh --init && ./build.sh --switch --local`
```bash
flutter run
```

Connect your phone / start an emulator and everything should work properly.
After completing these steps, the app should be running on your device or emulator with your local backend configuration.