updated readme, default host, and rebuilt
This commit is contained in:
parent
e6ade3b728
commit
eec7cc4101
3 changed files with 30 additions and 19 deletions
27
README.md
27
README.md
|
@ -1,14 +1,9 @@
|
||||||
# Spee.ch
|
# Spee.ch
|
||||||
Spee.ch is a web app that reads and publishes images and videos to and from the [LBRY](https://lbry.io/) blockchain.
|
|
||||||
|
spee.ch is a node-based web server that uses a lbrynet daemon to interact with the lbry network.
|
||||||
|
|
||||||
##Installation
|
##Installation
|
||||||
* start mysql
|
|
||||||
* install mysql
|
|
||||||
* create a database called `lbry`
|
|
||||||
* save your connection `username` and `password` someplace handy
|
|
||||||
* start lbrynet daemon
|
|
||||||
* install the [`lbry`](https://github.com/lbryio/lbry) daemon
|
|
||||||
* start the `lbry` daemon
|
|
||||||
* start spee.ch
|
* start spee.ch
|
||||||
* clone this repo
|
* clone this repo
|
||||||
* run `npm install`
|
* run `npm install`
|
||||||
|
@ -58,3 +53,19 @@ Spee.ch is a web app that reads and publishes images and videos to and from the
|
||||||
|
|
||||||
## Bugs
|
## Bugs
|
||||||
If you find a bug or experience a problem, please report your issue here on github and find us in the lbry discord!
|
If you find a bug or experience a problem, please report your issue here on github and find us in the lbry discord!
|
||||||
|
|
||||||
|
## Contribute
|
||||||
|
|
||||||
|
### below is a guide to the issue tags in this repo
|
||||||
|
level 1 - issues with spee.ch that anyone with basic web development can handle, little-to-no experience with the spee.ch codebase is required.
|
||||||
|
|
||||||
|
level 2 - issues with spee.ch familiarity with the spee.ch codebase is required, but little-to-no familiarity with the lbry daemon is necessary
|
||||||
|
|
||||||
|
level 3 - issues with spee.ch strong familiarity with the spee.ch code base and how the lbry daemon functions is required
|
||||||
|
|
||||||
|
level 4 - issues with lbry (e.g. the spee.ch wallet, lbrynet configuration, etc.) that require strong familiarity with the lbry daemon and/or network to fix. Generally these issues are best suited for the lbry protocol team but are placed in this repo because of they are part of the spee.ch implementation
|
||||||
|
|
||||||
|
The spee.ch stack is MySQL, Express.js, Node.js, React.js. Spee.ch runs lbrynet on its server, and spee.ch uses the lbrynet api to make requests such as `publish`, `create_channel`, and `get`.
|
||||||
|
|
||||||
|
spee.ch also runs a sync tool, which decodes the lbry blocks as they are mined and stores the claims in a mysql. It stores all claims in the `Claims` table, and all channel claims in the `Certificates` table.
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@ function SiteConfig () {
|
||||||
this.assetDefaults = {
|
this.assetDefaults = {
|
||||||
description: 'An asset published on Spee.ch',
|
description: 'An asset published on Spee.ch',
|
||||||
thumbnail : 'https://spee.ch/assets/img/video_thumb_default.png',
|
thumbnail : 'https://spee.ch/assets/img/video_thumb_default.png',
|
||||||
title : 'Spee.ch',
|
title : 'A Spee.ch Implementation',
|
||||||
};
|
};
|
||||||
this.auth = {
|
this.auth = {
|
||||||
sessionKey: 'default',
|
sessionKey: 'default',
|
||||||
|
@ -14,11 +14,11 @@ function SiteConfig () {
|
||||||
this.customContainers = {};
|
this.customContainers = {};
|
||||||
this.customPages = {};
|
this.customPages = {};
|
||||||
this.details = {
|
this.details = {
|
||||||
description: 'Open-source, decentralized image and video sharing.',
|
description: 'Welcome to my decentralized image and video sharing site.',
|
||||||
host : 'default',
|
host : 'http://localhost:3000',
|
||||||
port : 3000,
|
port : 3000,
|
||||||
title : 'Spee.ch',
|
title : 'My Spee.ch Site',
|
||||||
twitter : '@spee_ch',
|
twitter : '@exampleTwitterHandle',
|
||||||
};
|
};
|
||||||
this.publishing = {
|
this.publishing = {
|
||||||
additionalClaimAddresses: [],
|
additionalClaimAddresses: [],
|
||||||
|
|
12
index.js
12
index.js
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue