Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 1.82 KB

README.md

File metadata and controls

67 lines (47 loc) · 1.82 KB
Raw

blymp.io logo

blymp.io

Easily transfer files between devices

blymp.io is a webapp that allows you to easily transfer files between devices with high speeds.

It uses modern technologies like WebRTC, Blobs and WebSockets to allow files to be transferred as fast as possible.

You can use blymp.io by going to https://blymp.io. Feeling adventurous? Try blymp.io's newest features on https://next.blymp.io

Features

  • WebRTC file transfer
  • PWA
  • No registration
  • Privacy-oriented
  • Open-source
  • Automatic lossless compression using zlib
  • Developed in Typescript

Quick Start

# Clone the repository
git clone https://github.com/vantezzen/blymp-io

# Go inside the directory
cd blymp-io

# Install dependencies
yarn (or npm install)

# Start development server
yarn dev (or npm run dev)
# This will automatically open your browser

# Build for production
yarn build (or npm run build)

# Start production server
yarn start (or npm start)

Alternatively, you can start blymp.io using Docker using the Dockerfile contained in this repository.

Folder Structure

All the source code are inside the src directory.

Inside src, there is client and server directory. All the frontend code (react, css, js and any other assets) are in the client directory, backend Node.js/Express code are in the server directory.

Additional static assets are stored inside the public directory. Files in this folder will be copied over to the dist folder using webpack.

webpack builds production files into the dist directory.