An image hosting service on top of the LBRY protocol.
auth | ||
config | ||
constants | ||
controllers | ||
devConfig | ||
helpers | ||
migrations | ||
models | ||
passport | ||
public | ||
react | ||
routes | ||
task-scripts | ||
test | ||
views | ||
.eslintignore | ||
.eslintrc | ||
.gitignore | ||
.sequelizerc | ||
index.js | ||
index.js.map | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md | ||
server.js | ||
webpack.client.common.js | ||
webpack.config.js | ||
webpack.dev.js | ||
webpack.prod.js | ||
webpack.server.common.js |
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
andpassword
someplace handy
- start lbrynet daemon
- install the
lbry
daemon - start the
lbry
daemon
- install the
- start spee.ch
- clone this repo
- run
npm install
- create your
speechConfig.js
file- copy
speechConfig.js.example
and name itspeechConfig.js
- replace the
null
values in the config file with the appropriate values for your environment
- copy
- 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
- Note: this tool will decode blocks from the
Tests
- Spee.ch uses
mocha
withchai
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
- example:
- /api/claim/list/:name
- example:
curl https://spee.ch/api/claim/list/doitlive
- example:
- /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 ifchannelName
is provided)
- example:
Bugs
If you find a bug or experience a problem, please report your issue here on github and find us in the lbry discord!