Skip to content

Commit 0a93f71

Browse files
AlaaElattarAlaaElattar
committed
update readme files
1 parent e7f015c commit 0a93f71

File tree

2 files changed

+121
-105
lines changed

2 files changed

+121
-105
lines changed

‎README.md

Lines changed: 8 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -4,124 +4,39 @@
44

55
Threefold Connect is a mobile app that serves as your main gateway to the Threefold Grid and various other Threefold products and services.
66

7-
It contains an ultra secure 2FA authenticator for authenticating through third party applications.
8-
9-
Inside the app, you can manage your Threefold Tokens(TFT).
10-
11-
## Features ✨
12-
13-
### Wallet
14-
15-
In the ThreeFold Connect app, you can:
16-
17-
- Manage your ThreeFold Tokens (TFT) across multiple wallets
18-
- Import existing wallets using seed phrases or secret keys
19-
- Send and receive tokens on both TFChain and the Stellar network
20-
- Bridge tokens between TFChain, Stellar and Solana networks
21-
- Verify your identity for KYC requirements
22-
- Monitor your balance in real-time
23-
- Manage contacts for easy transfers
24-
25-
### Farm
26-
27-
In the ThreeFold Connect app, you can:
28-
29-
- Create and manage both v3 and v4 farms
30-
- View farm details and configurations
31-
- Track node status (online/offline) in real-time
32-
33-
### Node Monitoring
34-
35-
- Receive proactive notifications when nodes go offline
36-
- Smart notification system that categorizes offline nodes:
37-
- Recent outages (0-1 hour): Notifications every 15 minutes
38-
- Short outages (1-4 hours): Notifications every hour
39-
- Medium outages (4-24 hours): Notifications every 4 hours
40-
- Extended outages (1-3 days): Notifications every 12 hours
41-
- Long outages (3-7 days): Notifications once daily
42-
- Very long outages (beyond 7 days): Notifications suppressed
43-
44-
### DAO
45-
46-
Inside the app, you can vote on TFChain proposals and view the results of your votes.
47-
48-
### Threefold News
49-
50-
Inside the app, there is a "News" section where you can find all the latest Threefold news!
51-
52-
### Identity
53-
54-
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.
55-
56-
### Support
57-
58-
If you have Threefold related questions, we provide a support chat where we will answer your questions as soon as possible!
59-
607
## Local development
618

62-
### External repositories
63-
64-
Threefold News: <https://github.com/threefoldtech/threefold_connect_news>
65-
66-
Wallet v3: <https://github.com/threefoldtech/wallet-next>
67-
68-
Farmer: <https://github.com/threefoldtech/wallet-next>
69-
70-
Support: <https://github.com/threefoldtech/test_feedback>
71-
72-
## Frontend
73-
74-
Make sure the correct configuration is inside config.js. After that start the frontend by doing:
75-
76-
`yarn && yarn serve`
77-
78-
## Backend
79-
80-
Go inside virtual environment:
81-
82-
`source ./venv/bin/activate`
83-
84-
Start UWSGI backend:
85-
86-
```bash
87-
uwsgi --http :5000 --gevent 1000 --http-websockets --master --wsgi-file __main__.py --callable app -s 0.0.0.0:3030
88-
: 1643024584:0;uwsgi --http :5000 --gevent 1000 --http-websockets --master --wsgi-file __main__.py --callable app -s 0.0.0.0:3030
89-
```
9+
- check [app/README.md](app/README.md)
9010

9111
## App
9212

9313
### Setup and Run the Mobile App
9414

9515
1. **Prerequisites**
96-
- Install Flutter 3.27.2
9716

98-
2. **Configure the App**
99-
- Navigate to the app directory: `cd app`
100-
- Copy configuration templates:
17+
- Install Flutter 3.27.2
10118

102-
```bash
103-
dart run build_runner build
104-
```
19+
2. **Initialize the Environment**
10520

106-
3. **Initialize the Environment**
10721
- Run the initialization script:
10822

10923
```bash
11024
./build.sh --init
11125
```
11226

113-
- Switch to local development environment:
27+
- Switch to your preferred environment (local, testing, staging, or production):
11428

11529
```bash
116-
./build.sh --switch --local
30+
./build.sh --switch --staging
11731
```
11832

119-
4. **Run the App**
33+
3. **Run the App**
34+
12035
- Connect your Android/iOS device or start an emulator
12136
- Launch the app:
12237

12338
```bash
12439
flutter run
12540
```
12641

127-
After completing these steps, the app should be running on your device or emulator with your local backend configuration.
42+
After completing these steps, the app should be running on your device or emulator with staging backend configuration.

‎app/README.md

Lines changed: 113 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# threebotlogin
1+
# Threefold Connect
22

3-
A decentralized login application
3+
Decentralized login application for Threefold grid.
4+
5+
It contains an ultra secure 2FA authenticator for authenticating through third party applications.
6+
7+
Inside the app, you can manage your Threefold Tokens(TFT).
48

59
## Getting Started
610

@@ -15,11 +19,116 @@ For help getting started with Flutter, view our
1519
[online documentation](https://flutter.dev/docs), which offers tutorials,
1620
samples, guidance on mobile development, and a full API reference.
1721

22+
## Features ✨
23+
24+
### Wallet
25+
26+
In the ThreeFold Connect app, you can:
27+
28+
- Manage your ThreeFold Tokens (TFT) across multiple wallets
29+
- Import existing wallets using seed phrases or secret keys
30+
- Send and receive tokens on both TFChain and the Stellar network
31+
- Bridge tokens between TFChain, Stellar and Solana networks
32+
- Verify your identity for KYC requirements
33+
- Monitor your balance in real-time
34+
- Manage contacts for easy transfers
35+
36+
### Farm
37+
38+
In the ThreeFold Connect app, you can:
39+
40+
- Create and manage both v3 and v4 farms
41+
- View farm details and configurations
42+
- Track node status (online/offline) in real-time
43+
44+
### Node Monitoring
45+
46+
- Receive proactive notifications when nodes go offline
47+
- Smart notification system that categorizes offline nodes:
48+
- Recent outages (0-1 hour): Notifications every 15 minutes
49+
- Short outages (1-4 hours): Notifications every hour
50+
- Medium outages (4-24 hours): Notifications every 4 hours
51+
- Extended outages (1-3 days): Notifications every 12 hours
52+
- Long outages (3-7 days): Notifications once daily
53+
- Very long outages (beyond 7 days): Notifications suppressed
54+
55+
### DAO
56+
57+
Inside the app, you can vote on TFChain proposals and view the results of your votes.
58+
59+
### Signing
60+
61+
Inside the app you can sign content with one of your wallets.
62+
63+
The content is hashed using md5 and signed using the private key of the wallet.
64+
65+
There are 3 ways to sign:
66+
67+
- **Sign with text**
68+
- Enter custom text directly in the app
69+
- Select which wallet to sign with
70+
- Optionally specify a destination URL to send the signed data
71+
- **Sign with QR Code**
72+
- Scan a QR code containing content to be signed
73+
- The app decodes the QR code and displays the content for review
74+
- Choose which wallet to use for signing
75+
- The QR code may contain:
76+
- Direct content to sign
77+
- A source URL to fetch content from
78+
- An optional destination URL for the signed data
79+
- **Sign with link**
80+
- Click on a specially formatted link
81+
- The app automatically fetches content from the link
82+
- Review the content before signing
83+
- Select a wallet to sign with
84+
85+
### Threefold News
86+
87+
Inside the app, there is a "News" section where you can find all the latest Threefold news!
88+
89+
### Identity
90+
91+
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.
92+
93+
### Support
94+
95+
If you have Threefold related questions, we provide a support chat where we will answer your questions as soon as possible!
96+
97+
98+
## Local development
99+
100+
### Frontend
101+
102+
Make sure the correct configuration is inside config.js. After that start the frontend by doing:
103+
104+
`yarn && yarn serve`
105+
106+
### Backend
107+
108+
Go inside virtual environment:
109+
110+
`source ./venv/bin/activate`
111+
112+
Start UWSGI backend:
113+
114+
```bash
115+
uwsgi --http :5000 --gevent 1000 --http-websockets --master --wsgi-file __main__.py --callable app -s 0.0.0.0:3030
116+
: 1643024584:0;uwsgi --http :5000 --gevent 1000 --http-websockets --master --wsgi-file __main__.py --callable app -s 0.0.0.0:3030
117+
```
118+
18119
## How to run the app on Android
19120

20121
1. Connect your android device (make sure you have a new android version)
21-
2. Choose your environment `testing|staging|production`
22-
3. Run `./build.sh --run --testing|staging|production`
122+
2. Choose your environment `local|testing|staging|production`
123+
3. Run `./build.sh --run --local|testing|staging|production`
124+
125+
## How to run the app on IOS
126+
127+
1. Connect your ios device (make sure you have a new ios version) or start an emulator
128+
2. Choose your environment `local|testing|staging|production`
129+
3. Run `./build.sh --run --local|testing|staging|production`
130+
4. Run `pod install` in the `ios` folder
131+
5. Open the app in XCode and run it from there
23132

24133
### Local run
25134

@@ -29,11 +138,3 @@ samples, guidance on mobile development, and a full API reference.
29138
4. Run [openkyc](https://github.com/threefoldtech/threefold_connect_openkyc/blob/master/readme.md.old#L83)
30139
5. Copy the file in `app_config_local.template` into `app_config_local.dart` and change the configuration to your local IP's
31140
6. Run the app using `./build.sh --run --local`
32-
33-
## Known issues
34-
35-
- <https://github.com/threefoldtech/threefold_connect/issues/306>
36-
37-
## TODO
38-
39-
- signingConfigs

0 commit comments

Comments
 (0)