CONTRIBUTION.md

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

1. Install qBitTorrent
2. In the preferences, set up the Web UI. You would have to set a new username nad password and with everything done, the qBitTorrent Web UI should be up and running in http://localhost:8080/

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

Prerequisites

• Flutter
• VSCode / Android Studio

Installation

1. Clone the repository from GitHub:

git clone https://github.com/CCExtractor/Flood_Mobile.git

2. Navigate to project's root directory:

cd flood_mobile

3. Check for Flutter setup and connected devices:

flutter doctor

4. Get the dependancies

flutter pub get

5. Installing packages (IOS ONLY)

cd ios
pod install --verbose

6. Run the app:

flutter run

Contributing

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