|
1 | 1 | # File Transfer App
|
2 | 2 |
|
3 |
| -A simple, standalone Python-based application for transferring files between a mobile device and a PC over a local network. This app features a QR code for easy connection and allows the user to select a folder for saving files. |
| 3 | +A simple Python-based application for transferring files between a mobile device and a PC over a local network. The app uses a QR code for easy connection and allows users to select a folder for saving files on the PC. |
| 4 | + |
| 5 | +## About the App |
| 6 | +This app was built using: |
| 7 | +- **Flask**: For the backend server handling file uploads. |
| 8 | +- **PyQt5**: For the graphical user interface on the PC. |
| 9 | +- **qrcode**: For generating QR codes to simplify mobile device connections. |
| 10 | +- **Pillow**: For handling image processing. |
| 11 | + |
| 12 | +## How to Use |
| 13 | +1. Download the `.exe` file from the releases section of the repository. |
| 14 | +2. Run the `.exe` file on your PC. |
| 15 | +3. Select the folder where you want to save uploaded files. |
| 16 | +4. Scan the displayed QR code with your mobile device to connect. |
| 17 | +5. Use the mobile web interface to upload files, which will be saved to the selected folder. |
| 18 | + |
| 19 | +## Collaboration |
| 20 | +Contributions are welcome! If you'd like to improve this project or add features, feel free to: |
| 21 | +- Submit an issue to report bugs or suggest enhancements. |
| 22 | +- Open a pull request with your changes. |
| 23 | +- Reach out if you have questions or ideas for collaboration. |
4 | 24 |
|
5 |
| -## Features |
6 |
| -- File upload from mobile devices. |
7 |
| -- Dynamic QR code generation for easy connection. |
8 |
| -- Customizable save folder on the PC. |
9 |
| -- Cross-platform compatibility. |
10 |
| -- Responsive web interface for mobile devices. |
11 |
| - |
12 |
| -## Requirements |
13 |
| - |
14 |
| -### Python Libraries |
15 |
| -- Flask |
16 |
| -- PyQt5 |
17 |
| -- qrcode |
18 |
| -- Pillow |
19 |
| - |
20 |
| -Install the required libraries with: |
21 |
| -```bash |
22 |
| -pip install flask pyqt5 qrcode[pil] |
23 |
| -``` |
24 |
| - |
25 |
| -## How to Run |
26 |
| -1. Clone the repository: |
27 |
| - ```bash |
28 |
| - git clone https://github.com/yourusername/file-transfer-app.git |
29 |
| - cd file-transfer-app |
30 |
| - ``` |
31 |
| -2. Run the application: |
32 |
| - ```bash |
33 |
| - python main.py |
34 |
| - ``` |
35 |
| -3. Scan the QR code displayed in the application window using your mobile device. |
36 |
| -4. Use the web interface to upload files to the selected folder. |
37 |
| - |
38 |
| -## Packaging into an Executable |
39 |
| -To create a standalone `.exe` file: |
40 |
| - |
41 |
| -1. Install PyInstaller: |
42 |
| - ```bash |
43 |
| - pip install pyinstaller |
44 |
| - ``` |
45 |
| -2. Run the following command: |
46 |
| - ```bash |
47 |
| - pyinstaller --onefile --noconsole --icon=custom_icon.ico main.py |
48 |
| - ``` |
49 |
| -3. The executable will be available in the `dist/` folder. |
50 |
| - |
51 |
| -## Custom Icon |
52 |
| -To use a custom icon: |
53 |
| -- Place an `.ico` file named `custom_icon.ico` in the same directory as `main.py`. |
54 |
| -- Include the `--icon=custom_icon.ico` option when packaging with PyInstaller. |
55 |
| - |
56 |
| -## Folder Structure |
57 |
| -``` |
58 |
| -file-transfer-app/ |
59 |
| -├── main.py # Main application script |
60 |
| -├── custom_icon.ico # Custom icon for the application |
61 |
| -├── static/ # Static files for Flask (if needed) |
62 |
| -└── README.md # Project README |
63 |
| -``` |
64 |
| - |
65 |
| -## Known Issues |
66 |
| -- Ensure that the PC and mobile device are on the same local network. |
67 |
| -- Disable firewall restrictions if the connection is blocked. |
68 |
| - |
69 |
| -## Contributing |
70 |
| -Feel free to submit issues or pull requests to improve this application. |
71 |
| - |
72 |
| -## License |
73 |
| -This project is licensed under the MIT License. See the `LICENSE` file for details. |
74 | 25 |
|
0 commit comments