README.md

FIleSync: WiFi File Sharing Application

FileSync is a file-sharing application, targeting Linux, Mac, Windows and Android platforms

Disclaimer

⚠️ The application is still a work in progress and was recently migrated to use Tauri v2(beta) thus some features may be inconsistent. To proceed anyway, see the release page

Getting Started

General Requirement

To compile the application or modify it locally, you need the following dependencies:

• Node.js - A JavaScript Runtime environment
• npm - A JavaScript package manager.
• Rust v1.70 or greater
• Android Studio To build and debug the Android application to build reliable and efficient software.

Once you have the dependencies installed, clone the project and install the required packages:

Workspace Requirements

The project may require some system requirements based on your platform see the necessary prerequisite for your operating system.

git clone https://github.com/opeolluwa/filesync.git
cd filesync 
npm run install

Roadmap

• Adaptive UI WIP
• Build an executable for the Mac operating system WIP
• Build an executable for the Linux Operating system WIP
• Build an executable for Window WIP
• Support mobile devices WIP
• Create a wifi hotspot on Unix Operating Systems
• Support dark mode
• Add walkthrough after installation

Acknowledgments

• Linux Wifi Hotspot
• File Streaming

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

License

This project is distributed under the MIT License