Giter VIP home page Giter VIP logo

recv's Introduction

recv

A super simple, super fast way to transfer text and URLs between devices.

Demo

Author's Note: It's pronounced "receive", but you're free to call it whatever.

Usage

  • You can use the website directly: recv.live

  • You can install the website as a PWA, and share directly to it to instantly create a room

  • You can download and install the recv CLI app from the Releases page:

    • Windows:

      • rename the recv-windows-XX.exe file to recv.exe and add it to PATH
      • simply type recv to create a room
      • type recv <roomcode> to join a room, eg. recv 12345
    • MacOS/Linux:

      • Extract recv from the recv-PLATFORM-XX.tar.gz file, and add it to PATH

        For eg. on linux you can do:

        tar -xvzf recv-linux-x86-64.tar.gz
        sudo install ./dist/recv /usr/local/bin

Deploy your own

  • Server (Includes the website)

    cd server
    go build ./cmd/server
    ./server

    This will run the web server on localhost:8000

    You can specify a port using the -p flag (defaults to 8000):

    ./server -p 5000
  • CLI

    cd server
    go build -o recv ./cmd/cli
    ./recv 12345

Local development

  • Server

    Edit the default parameters at the top of the the script tag in index.html. These include the website's domain name, and whether or not to use HTTPS/WSS.

    During development, you'll have to edit DOMAIN to be localhost:8000 (or whichever port you choose to run it at), and SECURE to be false.

    you will need air installed for hot reload

    air -c .air.toml

    You can specify a port using the PORT environment variable:

    PORT=5000 air -c .air.toml
  • CLI

    Edit the default parameters in InitConfig in config.go. These include the website's domain name, and whether or not to use HTTPS/WSS.

    Note that in dev mode (when APP_ENV=dev) you'll always use http and localhost.

    APP_ENV=dev go run ./cmd/cli

    You can specify port and room code using environment variables:

    PORT=5000 ROOM=12345 go run ./cmd/cli

recv's People

Contributors

tusharsadhwani avatar imgbotapp avatar niftytyro avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.