LBRYCommunity/lbry.tech
1
0
Fork 0
Code Issues 13 Pull requests 8 Projects Releases Packages Wiki Activity

Closes #23

Browse source
This commit is contained in:
Kristian Polso 2018-05-10 16:06:12 +03:00
parent c85d769da3
commit d805604cb1
2 changed files with 61 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,19 @@
# Contributing
This project follows the global contributing standards for all LBRY projects, to read those go [here](https://lbry.io/faq/contributing)
You can contribute to this project by [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
Want to contribute by editing the text content on the site? This is easy, as all the pages are hosted as markdown files. Just use the "Edit this page on Github" found at the bottom of every page on the website.
## Code Overview
This project is a Vuepress-based static documentation website. This includes both the backend and frontend of the website at [beta.lbry.tech](https://beta.lbry.tech). All of this packaged and build with [Yarn](https://yarnpkg.com).
### Backend
Backend is handled by Node.js + Express. Currently all backend functionality is in one file, [server.js](server.js). It serves the static files generated by Vuepress. Additionally, it works as a proxy for some basic LBRY daemon method calls at daemon.lbry.tech.
### Frontend
[Vuepress](https://vuepress.vuejs.org/) generates static files based on the .vuepress folder and various markdown files in the root of the project. It automatically compiles JS and SCSS found in Vue components in .vuepress folder.

47
README.md
View file

@ -3,20 +3,40 @@ home: true
title: LBRY.tech
---
# LBRY.tech website
# LBRY.tech Website
Technical documentation website for [the LBRY protocol](https://lbry.io/).
Technical documentation website for [the LBRY protocol](https://lbry.io/) made with Javascript.
Built with:
Notable tools used:
* [Vue.js](https://vuejs.org/)
* [Vuepress](https://vuepress.vuejs.org/)
* [Vuetify](https://vuetifyjs.com/)
* [Highlight.js](https://highlightjs.org/)
## Build Setup
![Screenshot of LBRY.tech](https://spee.ch/f/lbry-tech-screenshot.png)
## Installation
This project is not designed to be installed directly. Continue reading below to learn how to use this project.
## Usage
Visit [beta.LBRY.tech](https://beta.lbry.tech) for hosted version for this repository.
## Running from Source
### Prequisities
* [Node](https://nodejs.org/) (version >= 9)
* [Yarn](https://yarnpkg.com/)
* [Vuepress](https://vuepress.vuejs.org/)
### Compiling
``` bash
# clone git project
git clone https://github.com/lbryio/lbry.tech
# install dependencies
yarn
@ -25,3 +45,20 @@ vuepress 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)