Skip to content

Latest commit

 

History

History
116 lines (80 loc) · 4.03 KB

CONTRIBUTING.md

File metadata and controls

116 lines (80 loc) · 4.03 KB
Raw

Getting Started

In order to use the mobile app, you would need the flood backend running on your local machine. There are several ways you can do that and all these approaches can be found at Flood WIKI The way I set it up was using qBitTorrent as the torrent client and Flood installed using the npm distribution

Steps

You can use qBitTorrent,Transmission or rTorrent(anyone) as the torrent client

Install qBitTorrent

  1. Install qBitTorrent
  2. Start the application, click the settings button and setup the Web UI. You would have to set a new username and password and with everything done, the qBitTorrent Web UI should be up and running in http://localhost:8080/

Screenshot 2022-12-20 at 11 04 PM

Screenshot 2021-05-25 at 1 59 24 PM

Install Transmission

  1. Install Transmission
  2. Start the application, click the edit button, select preferences and setup the Remote Control. You would have to set a new port, username and password and with everything done, the transmission app should be up and running in http://localhost:portnumber/
  3. Click Open web client button and access the app

trans

trans1

trans2

Install Flood

  1. Install Flood using sudo npm i -g flood / npm i -g flood
  2. Run flood using flood command. After this, flood should be running on http://127.0.0.1:3000
  3. Configure the torrent client in the flood web ui by entering the url for qBitTorrent web ui and the username and password.

Screenshot 2021-05-25 at 2 06 39 PM


Installation

  1. Clone the repository from GitHub:
git clone https://github.com/CCExtractor/Flood_Mobile.git
  1. Navigate to project's root directory:
cd Flood_Mobile
  1. Check for Flutter setup and connected devices:
flutter doctor
  1. Get the dependancies
flutter pub get
  1. Installing packages (IOS ONLY)
cd ios
pod install --verbose
  1. Run the app:
flutter run

Login into app

NOTE: MAKE SURE YOUR PC/LAPTOP SHOULD BE CONNECTED IN SAME NETWORK.

  1. Run flood with specific host
    1. Find your network ip
    2. Run following command:
    flood --host your_local_network_ip
Example:- flood --host 192.168.0.105
  2. Open mobile app fill following login credentials.
    1. URL :- http://your_local_network_ip:3000
    2. Flood Username
    3. Flood Password

Flood App Login Demo Image

Prerequisites

  • Flutter
  • VSCode / Android Studio

Contributing

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Add all files(git add .)
  4. Commit your Changes (git commit -m 'Add some AmazingFeature')
  5. Push to the Branch (git push origin feature/AmazingFeature)
  6. Open a Pull Request in the develop branch