Skip to content

Latest commit

 

History

History
86 lines (58 loc) · 1.62 KB

README.md

File metadata and controls

86 lines (58 loc) · 1.62 KB
Raw

Files2share

Files2share is a web app for sharing files between the devices on your local network.

Update:

The project uses QR Code to connect two devices, nothing goes to the server, and all the connections are made on the client side by scanning the QR Code on both devices.

Inspired by Snapdrop

Prevent duplicate option to prevent transfer files already exist on your device.

Built with:

  • Typescript, HTML, CSS
  • WebRTC
  • Webpack
  • streamSaver
  • DiceBear
  • Nodejs / SSE
  • Progressive Web App

How to run on your machine

Client

Navigate to /client, create an .env file and set the following environment variable:

SERVER_URL=http://localhost:4000

Run

  1. Install the dependencies with:
yarn
  1. Run start:
yarn start

Server

Navigate to /server

Run

  1. Install the dependencies with:
yarn
  1. Watch for file changes:
yarn watch
  1. Run dev:
yarn dev

Contributions

It's opening to receive any kind of contribution, report issue, fix a bug or any kind of enhancement you can see & there's a todo list inside /client/src/index.ts, you can start with if you would like or you can suggest a new one.

  1. Fork this repository to your own GitHub account and then clone it to your local device.
  2. Create a new branch: git checkout -b MY_BRANCH_NAME
  3. You can now push to your own branch and open a pull request.