Code Monkey home page Code Monkey logo

spee.ch's Introduction

spee.ch

spee.ch is a single-serving site that reads and publishes images and videos to and from the LBRY blockchain.

how to run this repository locally

  • start mysql
    • install mysql
    • create a database called lbry
    • save your connection username and password someplace handy
  • start lbrynet daemon
    • install the lbry daemon
    • start the lbry daemon
  • start spee.ch-sync
  • start spee.ch
    • clone this repo
    • run npm install
    • create your speechConfig.js file
      • copy speechConfig.js.example and name it speechConfig.js
      • replace the null values in the config file with the appropriate values for your environement
    • to start the server, from your command line run node speech.js
      • To run hot, use nodemon instead of node
  • visit localhost:3000

Tests

  • Spee.ch uses mocha with chai for testing.
  • To run all tests that do not require LBC, run npm test -- --grep @usesLbc --invert
  • To run all tests, including those that require LBC (like publishing), simply run npm test

API

GET

  • /api/claim-resolve/:name
    • example: curl https://spee.ch/api/claim-resolve/doitlive
  • /api/claim-list/:name
    • example: curl https://spee.ch/api/claim-list/doitlive
  • /api/claim-is-available/:name (
    • returns true/false for whether a name is available through spee.ch
      • example: curl https://spee.ch/api/claim-is-available/doitlive
  • /api/channel-is-available/:name (
    • returns true/false for whether a channel is available through spee.ch
    • example: curl https://spee.ch/api/channel-is-available/@CoolChannel

POST

  • /api/claim-publish
    • example: curl -X POST -F 'name=MyPictureName' -F 'file=@/path/to/myPicture.jpeg' https://spee.ch/api/claim-publish
    • Parameters:
      • name
      • file (must be type .mp4, .jpeg, .jpg, .gif, or .png)
      • nsfw (optional)
      • license (optional)
      • title (optional)
      • description (optional)
      • thumbnail url to thumbnail image, for .mp4 uploads only (optional)
      • channelName(optional)
      • channelPassword (optional,; required if channelName is provided)

bugs

If you find a bug or experience a problem, please report your issue here on github and find us in the lbry discord!

spee.ch's People

Contributors

bitspill avatar bones7242 avatar caseyparker avatar chickenpie347 avatar filipnyquist avatar joshstrobl avatar kauffj avatar lyoshenka avatar maximest-pierre avatar msftserver avatar noliverio avatar oakey22 avatar piste avatar stoatally avatar ykris45 avatar

Watchers

 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.