|
2 | 2 |
|
3 | 3 | <!-- GETTING STARTED -->
|
4 | 4 |
|
5 |
| -## Getting Started |
| 5 | +# Getting Started |
6 | 6 |
|
7 | 7 | In order to use the mobile app, you would need the flood backend running on your local machine. There are several ways
|
8 | 8 | you can do that and all these approaches can be found at [Flood WIKI](https://github.com/jesec/flood/wiki)
|
9 | 9 | The way I set it up was using [qBitTorrent](https://www.qbittorrent.org/) as the torrent client and Flood installed
|
10 | 10 | using the npm distribution
|
11 | 11 |
|
12 |
| -### Steps |
| 12 | +## Steps |
13 | 13 |
|
| 14 | +### Install qBitTorrent |
14 | 15 | 1. Install [qBitTorrent](https://www.qbittorrent.org/)
|
15 | 16 | 2. In the preferences, set up the Web UI. You would have to set a new username and password and with everything done,
|
16 | 17 | the qBitTorrent Web UI should be up and running in ```http://localhost:8080/```
|
17 | 18 |
|
18 |
| -<img width="400" alt="Screenshot 2021-05-25 at 1 59 24 PM" src="https://user-images.githubusercontent.com/52864956/119465947-c9cc0300-bd61-11eb-97a4-7889aec00fe9.png"> |
| 19 | +<p align="center"><img width="400" alt="Screenshot 2021-05-25 at 1 59 24 PM" src="https://user-images.githubusercontent.com/52864956/119465947-c9cc0300-bd61-11eb-97a4-7889aec00fe9.png"></p> |
19 | 20 |
|
20 |
| -3. Install Flood using ```sudo npm i -g flood``` |
21 |
| -4. Run flood using ```flood```. After this, flood should be running on ```http://127.0.0.1:3000``` |
22 |
| -5. Configure the torrent client in the flood web ui by entering the url for qBitTorrent web ui and the username and |
23 |
| - pasword. |
| 21 | +### Install Flood |
24 | 22 |
|
25 |
| -<img width="400" alt="Screenshot 2021-05-25 at 2 06 39 PM" src="https://user-images.githubusercontent.com/52864956/119466727-8aea7d00-bd62-11eb-860c-a85398ef3113.png"> |
| 23 | +1. Install Flood using ```sudo npm i -g flood``` / ```npm i -g flood``` |
| 24 | +2. Run flood using ```flood``` command. After this, flood should be running on ```http://127.0.0.1:3000``` |
| 25 | +3. Configure the torrent client in the flood web ui by entering the url for qBitTorrent web ui and the username and password. |
26 | 26 |
|
27 |
| -### Prerequisites |
| 27 | +<p align="center"><img width="400" alt="Screenshot 2021-05-25 at 2 06 39 PM" src="https://raw.githubusercontent.com/KunjKanani/assets/main/Flood-Login-Img.png"></p> |
28 | 28 |
|
29 |
| -* Flutter |
30 |
| -* VSCode / Android Studio |
| 29 | +<br /> |
31 | 30 |
|
32 | 31 | ### Installation
|
33 |
| - |
34 | 32 | 1. Clone the repository from GitHub:
|
35 | 33 |
|
36 | 34 | ```bash
|
@@ -68,11 +66,36 @@ pod install --verbose
|
68 | 66 | flutter run
|
69 | 67 | ```
|
70 | 68 |
|
| 69 | +### Login into app |
| 70 | +___ |
| 71 | + |
| 72 | +> NOTE: MAKE SURE YOUR PC/LAPTOP SHOULD BE CONNECTED IN SAME NETWORK. |
| 73 | +___ |
| 74 | + |
| 75 | +1. Run flood with specific host |
| 76 | + 1. [Find your network ip](https://en.wikipedia.org/wiki/Ipconfig) |
| 77 | + 2. Run following command: |
| 78 | + ``` |
| 79 | + flood --host your_local_network_ip |
| 80 | + Example:- flood --host 192.168.0.105 |
| 81 | + ``` |
| 82 | +2. Open mobile app fill following login credentials. |
| 83 | + 1. URL :- http://your_local_network_ip:3000 |
| 84 | + 2. Flood Username |
| 85 | + 3. Flood Password |
| 86 | +
|
| 87 | +<p align="center"><img width="300" alt="Flood App Login Demo Image" src="https://raw.githubusercontent.com/KunjKanani/assets/main/Screenshot_2021-11-11-20-52-46-21_cee4b64e37a5d4be45a41b3aa0b225bb.jpg"></p> |
| 88 | +
|
| 89 | +## Prerequisites |
| 90 | +
|
| 91 | +* Flutter |
| 92 | +* VSCode / Android Studio |
| 93 | +
|
71 | 94 | ## Contributing
|
72 | 95 |
|
73 | 96 | 1. Fork the Project
|
74 | 97 | 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
| 98 | +3. Add all files(`git add .`) |
75 | 99 | 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
76 | 100 | 4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
77 |
| -5. Open a Pull Request in the **develop branch** |
78 |
| - |
| 101 | +5. Open a Pull Request in the **develop branch** |
0 commit comments