lbry.tech/README.md

78 lines
2.4 KiB
Markdown
Raw Normal View History

2018-08-31 21:24:41 +02:00
<h1 align="center">lbry.tech</h1>
2018-06-06 14:35:18 +02:00
2018-08-31 21:24:41 +02:00
<div align="center">
<strong>We came from the future to help you save the Internet</strong>
</div>
2018-08-31 21:24:41 +02:00
<div align="center">
2018-08-31 21:27:30 +02:00
Technical documentation website for <a href="https://lbry.io">the LBRY protocol</a>.
2018-08-31 21:24:41 +02:00
</div>
<div align="center">
2018-10-10 23:18:12 +02:00
<img src="https://spee.ch/f2c2c29f7e6a76d84b341c5f42a832db7589b410/dottech-2018-october.png" title="Screenshot of lbry.tech"/>
2018-08-31 21:24:41 +02:00
</div>
<div align="center">
2019-01-08 17:54:56 +01:00
<a href="https://travis-ci.org/lbryio/lbry.tech">
<img src="https://img.shields.io/travis/lbryio/lbry.tech/master.svg?style=flat-square"/>
</a>
<a href="https://snyk.io/test/github/lbryio/lbry.tech">
2019-01-08 17:59:36 +01:00
<img src="https://snyk.io/test/github/lbryio/lbry.tech/badge.svg?style=flat-square"/>
2019-01-08 17:54:56 +01:00
</a>
2018-08-31 21:24:41 +02:00
</div>
2018-05-10 15:06:12 +02:00
2018-07-12 17:21:42 +02:00
## Prerequisites
- [lbry/web-daemon](https://github.com/lbryio/web-daemon)
- [Node](https://nodejs.org) (version >= 10)
2018-05-10 15:06:12 +02:00
## Notes
- **This repo will not run locally if you do not also have the LBRY app/daemon and the [web-daemon](https://github.com/lbryio/web-daemon) running.**
- When running locally and completing the tipping example in Playground, the LBC donated to a creator comes from _your_ LBC balance. Otherwise, the example will fail. On production, the donated LBC comes from LBRY.
## Local Installation
2019-01-28 15:51:16 +01:00
### npm
```bash
npm install
```
2019-01-28 15:51:16 +01:00
### Yarn
2019-01-28 15:51:16 +01:00
There is a yarn.lock file, you can thus use yarn to install a guaranteed working configuration of packages. This is generally a lot faster to install and more stable. Yarn as a CLI is not necessarily more stable than npm and as such, it's optional. Install yarn here: https://yarnpkg.com/en/docs/install
Then
```bash
yarn install
```
2018-05-10 15:06:12 +02:00
2018-07-12 17:21:42 +02:00
## Development
`npm run watch` and visit [localhost:8080](http://localhost:8080)
2018-05-10 15:06:12 +02:00
## Testing
`npm test`
2018-05-10 15:06:12 +02:00
## Production
`npm start`
2018-07-12 17:21:42 +02:00
## Usage
Visit [LBRY.tech](https://lbry.tech) to see this repo in production.
2018-05-10 15:06:12 +02:00
## Contributing
2018-10-04 00:10:04 +02:00
Contributions to this project are welcome, encouraged, and compensated.
2018-10-04 00:10:52 +02:00
2018-10-04 00:10:04 +02:00
For more details, see [CONTRIBUTING.md](CONTRIBUTING.md).
2018-07-12 17:21:42 +02:00
2018-05-10 15:06:12 +02:00
## License
2018-11-01 17:23:38 +01:00
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
2018-07-12 17:21:42 +02:00
2018-05-10 15:06:12 +02:00
## Security
2018-10-04 00:10:04 +02:00
We take security seriously. Please contact [security@lbry.io](mailto:security@lbry.io) regarding any security issues.
2018-10-04 00:10:52 +02:00
2018-10-04 00:10:04 +02:00
[Our PGP key is here](https://keybase.io/lbry/key.asc) if you need it.
2018-05-10 15:06:12 +02:00
## Contact
2018-11-01 17:33:27 +01:00
The primary contact for this project is [@netoperatorwibby](https://github.com/netoperatorwibby) (paul@lbry.io).