https://github.com/luxuereal/filesync_tauri

https://github.com/luxuereal/filesync_tauri

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/luxuereal/filesync_tauri
• Owner: luxuereal
• License: mit
• Created: 2023-09-09T02:23:25.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-12T14:02:12.000Z (about 1 year ago)
• Last Synced: 2024-11-08T23:52:11.437Z (about 2 months ago)
• Language: Rust
• Size: 3.56 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# FIleSync: WiFi File Sharing Application

![screenshot](screenshots/home-light.png)

## Table of Contents

- [Description](#description)

- [Getting Started](#getting-started)

- [Tech Stack](#technology-stack)

- [Features](#features)

- [Acknowledgement](#acknowledgements)

- [Contributing](#contributing)

- [License](#license)

## Description

FIleSync is an offline 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](https://nodejs.org) - A JavaScript Runtime environment

- [Yarn](https://yarnpkg.com/) - A fast, secure and reliable package manager for Node.js

- [Rust v1.70 or greater](https://www.rust-lang.org/) - A language empowering everyone

  to build reliable and efficient software.

In addition, this project uses Tauri v1.3, see [prerequisite](https://tauri.app/v1/guides/getting-started/prerequisites/) for your operating system.

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

```sh

git clone https://github.com/opeolluwa/wi-share.git wi-share

cd wi-share # 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](https://tauri.app/) is a framework for building cross-platform desktop applications with front-end web technologies.

- [React](https://react.dev/) - JavaScript library for building user interfaces

- [Next.js](https://nextjs.org/) - React framework for the web

- [Rust](rust-lang.org/) - A language empowering everyone

  to build reliable and efficient software.

- [Typescript](https://typescript-lang.org) - A strongly-typed programming language that builds on JavaScript

- [TailwindCSS](https://tailwindcss.com) - A utility-first CSS framework

## Features

- [x] Adaptive UI

- [x] scan to connect mobile

- [x] build an executable for the Mac operating system

- [x] build an executable for the Linux Operating system

- [ ] create a wifi hotspot

- [ ] build the user interface for mobile devices

- [ ] support dark mode

- [ ] add walkthrough after installation

- [ ] build an executable for Window

## Acknowledgements

- [Linux Wifi Hotspot](https://awesomeopensource.com/project/elangosundar/awesome-README-templateshttps://github.com/lakinduakash/linux-wifi-hotspot)

- [File Streaming](https://github.com/tokio-rs/axum/tree/main/examples/stream-to-file)

## Contributing

Contributions are always welcome!

See [contributing.md](./CONTRIBUTING.md) for ways to get started.

Please adhere to this project's [code of conduct](CODE_OF_CONDUCT.md).

## License

This project is distributed under the [MIT License](./LICENSE)