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

Minor fixes

Browse source
This commit is contained in:
ポール ウェッブ 2018-07-12 16:30:26 -05:00
parent 754b92fc08
commit cf98a4a9c8
4 changed files with 19 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
CONTRIBUTING.md
View file

@ -1,19 +1,25 @@
# Contributing
This project follows the global contributing standards for all LBRY projects, to read those go [here](https://lbry.io/faq/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 most of the pages are Markdown files. Just use the "Edit this page on Github" found at the bottom of every page on the website.
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 [lbry.tech](https://lbry.tech). All of this packaged and build with [Yarn](https://yarnpkg.com).
This project is a JavaScript-based documentation website and includes both the backend and frontend of the website at [lbry.tech](https://lbry.tech).
### 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
### Back-End
[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.
Node.js + [Fastify](https://www.fastify.io) handles the back-end of this site. All back-end functionality is in one file, [server.js](server.js). Additionally, the back-end works as a proxy for some basic LBRY daemon method calls at `daemon.lbry.tech`.
### Front-End
[choo](https://choo.io) handles the front-end of this site. Sass files are automatically compiled when edited.

21
LICENSE
View file

@ -1,21 +0,0 @@
MIT License
Copyright (c) 2018 Kristian Polso
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

6
README.md
View file

@ -2,14 +2,14 @@
Technical documentation website for [the LBRY protocol](https://lbry.io) made with JavaScript.
[![Build Status](https://travis-ci.org/lbryio/lbry.tech.svg?branch=master)](https://travis-ci.org/lbryio/lbry.tech)
[![Build Status](https://travis-ci.org/lbryio/lbry.tech.svg?branch=new)](https://travis-ci.org/lbryio/lbry.tech)
Notable tools used:
* [choo](https://choo.io)
* [fastify](https://www.fastify.io)
* [Fastify](https://www.fastify.io)
![Screenshot of LBRY.tech](https://spee.ch/f/lbry-tech-screenshot.png)
@ -41,7 +41,7 @@ Contributions to this project are welcome, encouraged, and compensated. For more
## License
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
This project is MIT licensed.

4
views/partials/ecosystem.js
View file

@ -55,7 +55,7 @@ module.exports = exports = class Ecosystem extends Component {
<h4 class="ecosystem__submodule__description__title">Source</h4>
<ul>
<li><a href="https://github.com/lbryio/lbry-app" title="lbry-app source code">https://github.com/lbryio/lbry-app</a></li>
<li><a href="https://github.com/lbryio/lbry-desktop" title="lbry-desktop source code">https://github.com/lbryio/lbry-desktop</a></li>
</ul>
<ul class="__parents">
@ -252,7 +252,7 @@ module.exports = exports = class Ecosystem extends Component {
<h3>Additional Resources</h3>
<ul>
<li><a href="https://github.com/lbryio/lbry-app" title="source code for LBRY's desktop apps">Linux, macOS, and Windows apps</a></li>
<li><a href="https://github.com/lbryio/lbry-desktop" title="source code for LBRY's desktop apps">Linux, macOS, and Windows apps</a></li>
<li><a href="https://github.com/lbryio/lbry-android" title="LBRY Android app source code">Android app</a></li>
<li><a href="https://github.com/lbryio/spee.ch" title="spee.ch source code">spee.ch</a></li>
<li><a href="https://github.com/lbryio/lighthouse" title="lighthouse source code">lighthouse</a></li>