LBRYCommunity/lbry-desktop
1
0
Fork 0
Code Issues 596 Pull requests 6 Projects Releases 238 Packages Wiki Activity

doc updates

Browse source
This commit is contained in:
Sean Yesmunt 2018-05-11 01:12:53 -04:00
parent 4ef8401a35
commit c5d4bfc4b6
2 changed files with 31 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
CONTRIBUTING.md
View file

@ -5,6 +5,7 @@ application is primarily written in JavaScript and is built on [Electron](https:
while utilizing [React](https://reactjs.org) and [Redux](https://redux.js.org) for UI and
application state.
## TL;DR?
* [Here](https://github.com/lbryio/lbry-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+no%3Aassignee)
@ -52,12 +53,12 @@ would. If these rankings don't work for you, feel free to ignore them.
Although all contributions should have good UX, the [UX label, when applied in conjunction with Help Wanted](https://github.com/lbryio/lbry-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3Aux+no%3Aassignee), indicates that the contributor ought to implement the feature in a creative way that specifically focuses on providing a good user experience. These issues often have no set instruction for how the experience should be and leave it to the contributor to figure out. This may be challenging for people who do not like UX, but also more fun and rewarding for those who do.
## Develop
## Code Overview
The entry point for this application is `src/renderer/index.js`
The project comes with diverse tools for simplifying the development process and for providing
better code quality. It's recommended to make use of them thoroughly during ongoing development.
We follow the well-known [Airbnb JavaScript Style Guide](http://airbnb.io/javascript/) for defining
better code quality. It's recommended to make use of them thoroughly during ongoing development. We follow the well-known [Airbnb JavaScript Style Guide](http://airbnb.io/javascript/) for defining
our styling rules and code best practices.
### Flow
@ -76,14 +77,6 @@ definitions in the project by running:
`$ yarn flow-defs`
### Run
LBRY app can be run for development by using the command:
`$ yarn dev`
This will launch the app and provide HMR (Hot Module Replacement). Any change made to the sources
will automatically reload the app without losing its state.
### Lint
@ -177,10 +170,9 @@ will earn you an extra 50 LBC on top of what we would otherwise tip you.
# Get in Touch
| Name | Role | Discord | Email |
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------ |
| [Liam](https://github.com/liamcardenas) | The application engineer in charge of community development. He is the person to contact with any development/contribution related questions. | liamsdouble | liam@lbry.io |
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------
| [Tom](https://github.com/tzarebczan) | Community manager. He knows more than anyone about the app and all of its flaws. Reach out to him with any questions about how the app works, if a bug has been reported, or if a feature should be requested. | jiggytom | tom@lbry.io |
| [Sean](https://github.com/seanyesmunt) | An application engineer who focuses largely on UI/UX. If you have a design or implementation question, feel free to reach out to him. | sean | sean@lbry.io |
| [Sean](https://github.com/seanyesmunt) | The primary engineer working on the app. Feel free to ask any questions about how the code. | sean | sean@lbry.io |
Join our Discord [here](https://chat.lbry.io/).

49
README.md
View file

@ -12,7 +12,7 @@ The LBRY app is a graphical browser for the decentralized content marketplace pr
![App screenshot](https://lbry.io/img/lbry-ui.png)
## Installing
## Install
We provide installers for Windows, macOS (v10.9 or greater), and Debian-based Linux.
@ -26,47 +26,40 @@ release, pre-releases, and past builds.
To install from source or make changes to the application, continue reading below.
## Getting Started
## Usage
Double click the installed application to browse with the LBRY network.
These instructions will get you a copy of the project up and running on your local machine for
development and testing purposes.
## Running from Source
### Prerequisites
#### Prerequisites
* [Git](https://git-scm.com/downloads)
* [Node.js](https://nodejs.org/en/download/)
* [Yarn](https://yarnpkg.com/en/docs/install)
* [C++ Build Tools](https://github.com/felixrieseberg/windows-build-tools) (Only needed on Windows)
### Setup
#### Steps
1. Clone this repository
2. Run `$ yarn`
1. Clone this repository: `git clone https://github.com/lbryio/lbry-app`
2. Change directories into the downloaded folder: `cd lbry-app`
3. Install the dependencies: `yarn`
4. Run the app: `yarn dev`
### Run
The app can be run from the sources using the following command:
`$ yarn dev`
### Build
Run `$ yarn build`
We use [electron-builder](https://github.com/electron-userland/electron-builder) to create
If you want to just build the app you can run `yarn build`. This will give you an executable inside the `/dist` folder. We use [electron-builder](https://github.com/electron-userland/electron-builder) to create
distributable packages.
## Contributing
Contributions to this project are welcome, encouraged, and compensated. For more details, see [CONTRIBUTING.md](CONTRIBUTING.md)
Please read [our contributing manual](CONTRIBUTING.md) for details on how to develop for the
project and the process of submitting pull requests.
## Internationalization
If you want to help to translate the lbry-app, you can copy the `en.json` file in `/dist/locales/`
and modify the values while leaving the keys as their original English strings. An example for this
would be: `"Skip": "Überspringen",` Translations should automatically show up in options.
## License
[MIT © LBRY](LICENSE)
This project is MIT licensed. For the full license, see [LICENSE](LICENSE)
## Security
We take security seriously. Please contact 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 [@seanyesmunt](https://github.com/@seanyesmunt)