60 lines
1.5 KiB
Markdown
60 lines
1.5 KiB
Markdown
# LBRY.tech Website
|
|
|
|
[](https://travis-ci.org/lbryio/lbry.tech)
|
|
|
|
Technical documentation website for [the LBRY protocol](https://lbry.io/) made with Javascript.
|
|
|
|
Notable tools used:
|
|
|
|
* [Vue.js](https://vuejs.org/)
|
|
* [Vuepress](https://vuepress.vuejs.org/)
|
|
* [Highlight.js](https://highlightjs.org/)
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
This project is not designed to be installed directly. Continue reading below to learn how to use this project.
|
|
|
|
## Usage
|
|
|
|
Visit [LBRY.tech](https://lbry.tech) for hosted version for this repository.
|
|
|
|
## Running from Source
|
|
|
|
### Prerequisities
|
|
|
|
* [Node](https://nodejs.org/) (version >= 10)
|
|
* [Yarn](https://yarnpkg.com/)
|
|
|
|
### Compiling
|
|
|
|
``` bash
|
|
# clone git project
|
|
git clone https://github.com/lbryio/lbry.tech
|
|
|
|
# install dependencies
|
|
yarn
|
|
|
|
# serve with hot reload at localhost:8080
|
|
yarn dev
|
|
|
|
# build for production with minification & start express server
|
|
yarn start
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Contributions to this project are welcome, encouraged, and compensated. For more details, see [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
|
|
## License
|
|
|
|
This project is MIT licensed. For the full license, see [LICENSE](LICENSE)
|
|
|
|
## Security
|
|
|
|
We take security seriously. Please contact [security@lbry.io](mailto:security@lbry.io) regarding any security issues. [Our PGP key is here](https://keybase.io/lbry/key.asc) if you need it.
|
|
|
|
## Contact
|
|
|
|
The primary contact for this project is [@kauffj](https://github.com/kauffj)
|