senninseyi / send-file

offline file sharing application Windows, Mac and Linux operating systems

Sendfile

Offline file-sharing application for Windows, Mac and Linux operating systems

Table of Contents

• Description
• Getting Started
• Prerequisites
• Installation
• License

Description

Sendfile is a desktop application for Windows, Mac and Linux operating systems that allows you to send files seamlessly without the need for an internet connection.

Getting Started

The following are required to run the application in development

• Node.js - The JavaScript Runtime environment
• Yarn - A fast, secure and reliable package manager for Node.js
• Rust v1.67 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.

Prerequisites

Sendfile is built 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

Installation

To run the application in the development environment, set up the requirement specified in the Getting Started section afterward,

1. Install the UI dependencies, from the project root directory, run yarn install
2. Navigate to the application backend and install the dependencies, run cd core && cargo run
3. From the root directory, run

• yarn tauri dev to run the application in development mode.
• yarn tauri build to build the application executable

License

This project is proprietary software owned by Adeoye Adefemi and distributed under MIT License