An image hosting service on top of the LBRY protocol.
Find a file
2018-03-19 14:33:17 -07:00
client updated server file and webpacks 2018-03-19 14:11:05 -07:00
config Delete mysqlConfig.js 2018-03-19 14:33:17 -07:00
devConfig added slackconfig example 2018-03-19 14:32:25 -07:00
FAQ Create what-is-speech.md 2018-03-13 20:25:32 +01:00
public Delete bundle.js.map 2018-03-19 14:28:19 -07:00
server updated server file and webpacks 2018-03-19 14:11:05 -07:00
test reorganized file system 2018-03-16 10:34:26 -07:00
.eslintignore created public bundle 2018-03-08 13:21:13 -08:00
.eslintrc added standard-jsx to eslint and fixed issues 2018-02-21 17:02:57 -08:00
.gitignore added slackconfig example 2018-03-19 14:32:25 -07:00
.sequelizerc updated site config files 2018-03-12 19:26:03 -07:00
index.js moved server.js entry to root and updated build 2018-03-16 13:16:28 -07:00
index.js.map moved server.js entry to root and updated build 2018-03-16 13:16:28 -07:00
LICENSE create initial LICENSE file 2018-02-05 12:43:14 -08:00
package-lock.json Edited code to be ES6, added eslint and some basic linting configuration 2017-06-17 22:51:30 +02:00
package.json updated server file and webpacks 2018-03-19 14:11:05 -07:00
README.md updated app to use siteconfig rather than speechconfig 2018-03-09 18:23:19 -08:00
webpack.client.common.js updated server file and webpacks 2018-03-19 14:11:05 -07:00
webpack.config.js created build 2018-03-16 13:03:54 -07:00
webpack.dev.client.js updated server file and webpacks 2018-03-19 14:11:05 -07:00
webpack.dev.js created build 2018-03-16 13:03:54 -07:00
webpack.dev.server.js updated server file and webpacks 2018-03-19 14:11:05 -07:00
webpack.prod.js created build 2018-03-16 13:03:54 -07:00
webpack.server.common.js updated server file and webpacks 2018-03-19 14:11:05 -07:00

Spee.ch

Spee.ch is a web app that reads and publishes images and videos to and from the LBRY blockchain.

##Installation

  • 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
    • 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 environment
    • build the app by running npm run build-prod
    • to start the server, run npm run start
  • visit localhost:3000
  • start spee.ch-sync (optional, recommended)
    • Note: this tool will decode blocks from the lbry blockchain and update the Claim and Certificate tables in mysql with all the claims from the blockchain. This is not necessary if you only want to host and resolve content published through your version of spee.ch, but it is required if you want to retrieve and host other content from the lbry network.
    • install and run this speech-sync tool

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/:claimId
    • example: curl https://spee.ch/api/claim/resolve/doitlive/xyz
  • /api/claim/list/:name
    • example: curl https://spee.ch/api/claim/list/doitlive
  • /api/claim/availability/:name
    • returns the name if it is available
    • example: curl https://spee.ch/api/claim/availability/doitlive
  • /api/channel/availability/:name
    • returns the name if it is available
    • example: curl https://spee.ch/api/channel/availability/@CoolChannel

POST

  • /api/claim/publish
    • example: curl -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!