Skip to content

D3W10/SkyShare

Repository files navigation



Logo

SkyShare

Sharing, Simply Better


Download App · Report Bug · Request Feature


Table of Contents

  1. About
  2. Getting Started
  3. Development
  4. License
  5. Credits


About

SkyShare is both a desktop and a web application that allows you to share files between devices. The desktop app is available for both Windows and macOS, other devices can use the web app for sharing files.

This project consists in four different subprojects:

🖥️ SkyShare Desktop App

🔌 SkyShare API

🌐 SkyShare Web App

Note

The desktop app can also be compiled and used on Linux, just note that some bugs may occur.

App Homescreen


Built With



Getting Started

In order to use the application go to the releases page and download the latest version.


System Requirements

To run the app you need:

  • A computer running Windows or macOS:
    • Windows 10 or superior;
    • macOS 11.0 Big Sur or superior.
  • At least 400 MB of free space.

Installation

After downloading the setup from the releases page, run it and follow the on screen instructions to get SkyShare on your device. Once installed, find it on your Start Menu or Launchpad and open it.



Development

If you want to deploy a copy of SkyShare on your device to develop a feature or fix a bug, follow the steps below to get started.


Prerequisites

In order to run the application, you will need the following tools:

  • Node.JS (20.0.0 or higher);
  • bun (or equivalent);
  • git (optional).

Installation

  1. Clone the repository
    git clone https://github.com/D3W10/SkyShare.git
  2. Open the project folder using your prefered code editor (ex: VS Code)
  3. Install the required dependencies
    bun i
  4. On the project root run the following command to run the app
    bun run dev


License

Distributed under the Mozilla Public License 2.0. Check LICENSE for more details.



Credits

About

Sharing, Simply Better

Resources

License

Stars

Watchers

Forks

Contributors