lbry.tech/CONTRIBUTING.md

26 lines
1 KiB
Markdown
Raw Normal View History

2018-05-10 15:06:12 +02:00
# Contributing
2018-07-12 23:30:26 +02:00
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.
2018-05-10 15:06:12 +02:00
## Code Overview
2018-07-12 23:37:15 +02:00
This project is a JavaScript-based documentation website and includes both the back-end and front-end of the website at [lbry.tech](https://lbry.tech).
2018-07-12 23:30:26 +02:00
### Back-End
2018-07-12 23:37:15 +02:00
Node.js + [Fastify](https://www.fastify.io) handle 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`.
2018-05-10 15:06:12 +02:00
2018-07-12 23:30:26 +02:00
### Front-End
2018-05-10 15:06:12 +02:00
2018-07-12 23:30:26 +02:00
[choo](https://choo.io) handles the front-end of this site. Sass files are automatically compiled when edited.