Skip to content

opeolluwa/filesync

Repository files navigation

FIleSync: WiFi File Sharing Application

⚠️ the application is still a work in progress, hence, Some features are missing. Please see the issues page to contribute

screenshot

Table of Contents

Description

FIleSync is a wifi file-sharing application designed for Windows, Mac, and Linux operating systems. It allows users to transfer files seamlessly between PCs over WiFi without an internet connection.

Getting Started

To run the application in development, you'll need the following dependencies:

  • Node.js - A JavaScript Runtime environment
  • Yarn - A fast, secure and reliable package manager for Node.js
  • Rust v1.70 or greater - A language empowering everyone to build reliable and efficient software.

In addition, this project uses Tauri v1.3, see prerequisite for your operating system.

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

git clone https://github.com/opeolluwa/filesync.git
cd filesync # navigate to the cloned directory
yarn install # install the dependencies
yarn tauri dev # run the application locally

Technology Stack

WiShare is built primarily on the following technologies

  • Tauri is a framework for building cross-platform desktop applications with front-end web technologies.

  • React - JavaScript library for building user interfaces

  • Next.js - React framework for the web

  • Rust - A language empowering everyone to build reliable and efficient software.

  • Typescript - A strongly-typed programming language that builds on JavaScript

  • TailwindCSS - A utility-first CSS framework

  • Capacitor - Build cross-platform mobile application apps

Features

  • Adaptive UI
  • build an executable for the Mac operating system
  • build an executable for the Linux Operating system
  • build an executable for Window
  • create a wifi hotspot
  • support mobile devices
  • support dark mode
  • add walkthrough after installation

Acknowledgements

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