- Notifications
You must be signed in to change notification settings - Fork15
🌠 Blazing fast file transfer app focused on user-experience. Fastest way to share files without uploading them.
License
dot-cafe/beam.cafe
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
beam.cafe is a supercharged file-sharing application which lets you share files instantly, fully anonymously and direct.
I consider this project to have reached a final state.Today I would do many things differently (more component based, less interdependent modules etc.) than I did a year / years ago.I finished this project shortly after graduating high school and do not intent to actively work on it anymore.It was a great project and I learned many things from working on it though :)
It'll stay deployed until March 2022. Thereafter I'll take it down for security reason.Update: Because of financial reasons I decided to take it down at the beginning of November 2021.
beam.cafe knows very little about you - the names of your files, your IP and well, that's it.If you send over a file it won't get saved somewhere on the server but instead will be streamed from your local machine over the server of beam.cafe directly to your peer.You can always check who's downloading or streaming your files and, in case a link fell into the wrong hands, invalidate a file. Also, beam.cafe comes with a wide set of features:
- 💻 It's aPWA! You can install it on desktop and on your phone.
- 🌠 Blazing fast - No need to upload your files to unknown servers, your files are served directly from your local machine.
- 🌊 Streamable - Movies, large pictures or just a large audio-file? Stream it instead of downloading all of it!
- 🎁 Tiny - Beam Cafe only uses libraries with a minimal footprint such aspreact,graceful-ws andnanopop.
- 🔧 Customizable - Many settings around security, appearance, notifications and more!
- 🌜 Multi-themed - Light theme or dark theme? beam.cafe has both, even a high-contrast mode.
- 🦾 Accessible - High contrast theme paired with modern aria-labels will make using it an ease (PR's are welcome!).
- ✨ Modern - A modern design makes using beam.cafe a breeze.
You'll need both thefrontend andbackend to work on it:
# Clone repositoriesgit clone https://github.com/dot-cafe/beam.cafegit clone https://github.com/dot-cafe/beam.cafe.backend# Install and start both the front- and backendcd beam.cafe&& npm install&& npm run devcd ../beam.cafe.backend&& npm install&& npm run dev
The API will listen on port8080
and the front-end will be served from3000
, make sure these ports are open on your machine.
beam.cafe can be set up usingdocker-compose:
# Create directory for docker-compose.yml and all your config / build filesmkdir beam.cafe&&cd beam.cafe# Download docker-compose.yml and .env filecurl -sSL https://raw.githubusercontent.com/dot-cafe/beam.cafe/master/docker-compose.yml> docker-compose.ymlcurl -sSL https://raw.githubusercontent.com/dot-cafe/beam.cafe/master/.env.example> .env# Setup blank config filesmkdir config&&echo"{}"> config/backend.json
Make sure to update the variables in your.env
file before starting it.The documentation aboutbackend.json
can be foundhere. Thebackend.json
file will be merged with thedefault.json config file so it's okay to leave it empty ({}
).
If you're using nginx you can check outthis to see how to configure it properly.If you're using apache feel free to open an issue / PR to get that added as well.
Gohere to see how to set beam.cafe up manually.
... or justtry it out!
Maintaining a beaming cafe costs time and, although very little thanks to concept of beam.cafe, money. If you want you can support me onGitHub,Patreon, or you couldbuy me a coffee.
You've found a bug, have an idea for a future or want to make a PR? Check out ourcontribution guidelines to get started!
Many thanks toicons8 for the icons!
Special thanks toNathan S. for finding a name for this app!
About
🌠 Blazing fast file transfer app focused on user-experience. Fastest way to share files without uploading them.