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

More cleanup

Browse source
This commit is contained in:
Thomas Zarebczan 2022-01-31 11:38:57 -05:00
parent f09c6d7a50
commit 92f0fd8745
No known key found for this signature in database
GPG key ID: D505010BDB4364BC
11 changed files with 82 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
CONTRIBUTING.md
View file

@ -1,4 +1,4 @@
# Contribute to LBRY
# Contribute to Odysee
**First:** if you're unsure or afraid of anything, just ask or submit the issue or pull request anyways. You won't be yelled at for giving your best effort. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions, and don't want a wall of rules to get in the way of that.
@ -6,55 +6,52 @@ However, for those individuals who want a bit more guidance on the best way to c
## TL;DR?
- [Here](https://github.com/lbryio/lbry-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+no%3Aassignee)
- [Here](https://github.com/OdyseeTeam/odysee-frontend/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+no%3Aassignee)
is a list of help wanted issues.
- Comment on an issue to let us know if you are going to work on it, don't take an issue that someone reserved less than 3 days ago.
- Submit a pull request and get paid in LBC.
- Submit a pull request and get paid in Credits.
- Don't hesitate to contact us with any questions or comments.
## Contents
- [Choose an Issue](#choose-an-issue)
- [Code Overview](#code-overview)
- [Libraries](#libraries)
- [Flow](#flow)
- [Lint](#lint)
- [Code Formatting](#code-formatting)
- [Debug](#debug)
- [Submit a Pull Request](#submit-a-pull-request)
- [Tom's "Voice of the User" Wishlist](#toms-voice-of-the-user-wishlist)
- [Get in Touch](#get-in-touch)
- [More Information](#more-information)
## Choose an Issue
LBRY is an open source project and therefore is developed out in the open for everyone to see. What
Odysee is an open source project and therefore is developed out in the open for everyone to see. What
you see here are the latest source code changes and issues.
Since LBRY is based on a decentralized community, we believe that the app will be stronger if it
Since Odysee is based on a decentralized community, we believe that the app will be stronger if it
receives contributions from individuals outside the core team -- such as yourself!
To make contributing as easy and rewarding as possible, we have instituted the following system:
- Anyone can view all issues in the system by clicking on the
[Issues](https://github.com/lbryio/lbry-desktop/issues) button at the top of the page. Feel free to
add an issue if you think we have missed something (and you might earn some LBC in the process
[Issues](https://github.com/OdyseeTeam/odysee-frontend/issues) button at the top of the page. Feel free to
add an issue if you think we have missed something (and you might earn some Credits in the process
because we do tip people for reporting bugs).
- Once on the [Issues](https://github.com/lbryio/lbry-desktop/issues) page, a potential contributor can
- Once on the [Issues](https://github.com/OdyseeTeam/odysee-frontend/issues) page, a potential contributor can
filter issues by the
[Help Wanted](https://github.com/lbryio/lbry-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+no%3Aassignee)
[Help Wanted (in progress)](https://github.com/OdyseeTeam/odysee-frontend/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+no%3Aassignee)
label to see a curated list of suggested issues with which community members can help.
- Every
[Help Wanted](https://github.com/lbryio/lbry-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+no%3Aassignee)
issue is ranked on a scale from zero to four.
[Help Wanted](https://github.com/OdyseeTeam/odysee-frontend/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+no%3Aassignee)
issue is ranked on a scale from zero to four (in progress)
| Level | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| [**level 0**](https://github.com/lbryio/lbry-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22level%3A+0%22+no%3Aassignee) | Typos and text edits -- a tech-savvy non-programmer can fix these. |
| [**level 1**](https://github.com/lbryio/lbry-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22level%3A+1%22+no%3Aassignee) | Programming issues that require little knowledge of how the LBRY app works. |
| [**level 2**](https://github.com/lbryio/lbry-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22level%3A+2%22+no%3Aassignee) | Issues of average difficulty that require the developer to dig into how the app works a little bit. |
| [**level 3**](https://github.com/lbryio/lbry-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22level%3A+3%22+no%3Aassignee) | Issues that are likely too tricky to be level 2 or require more thinking outside of the box. |
| [**level 4**](https://github.com/lbryio/lbry-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22level%3A+4%22+no%3Aassignee) | Big features or really hard issues. |
| Level (in progress) | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| [**level 0**](https://github.com/OdyseeTeam/odysee-frontend/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22level%3A+0%22+no%3Aassignee) | Typos and text edits -- a tech-savvy non-programmer can fix these. |
| [**level 1**](https://github.com/OdyseeTeam/odysee-frontend/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22level%3A+1%22+no%3Aassignee) | Programming issues that require little knowledge of how the Odysee app works. |
| [**level 2**](https://github.com/OdyseeTeam/odysee-frontend/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22level%3A+2%22+no%3Aassignee) | Issues of average difficulty that require the developer to dig into how the app works a little bit. |
| [**level 3**](https://github.com/OdyseeTeam/odysee-frontend/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22level%3A+3%22+no%3Aassignee) | Issues that are likely too tricky to be level 2 or require more thinking outside of the box. |
| [**level 4**](https://github.com/OdyseeTeam/odysee-frontend/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+label%3A%22level%3A+4%22+no%3Aassignee) | Big features or really hard issues. |
The process of ranking issues is highly subjective. The purpose of sorting issues like this is to
give contributors a general idea about the type of issues they are looking at. For instance, it could very well be
@ -62,11 +59,11 @@ the case that a level 1 issue is more difficult than a level 2 issue. This syste
to help you find relevant issues, not to prevent you from working on issues that you otherwise
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-desktop/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.
Although all contributions should have good UX, the [UX label, when applied in conjunction with Help Wanted](https://github.com/OdyseeTeam/odysee-frontend/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.
## Code Overview
The entry point for this application is [`electron/index.js`](https://github.com/lbryio/lbry-desktop/blob/master/electron/index.js).
The entry point for this application is [`electron/index.js`](https://github.com/OdyseeTeam/odysee-frontend/blob/master/electron/index.js).
This application is primarily written in JavaScript and is built on [Electron](https://electronjs.org)
while utilizing [React](https://reactjs.org) and [Redux](https://redux.js.org) for UI and
@ -76,10 +73,6 @@ The project comes with diverse tools for simplifying the development process and
better code quality. It's recommended to make use of them thoroughly during ongoing development. We follow the well-known [Airbnb JavaScript Style Guide](https://airbnb.io/javascript/) for defining
our styling rules and code best practices.
### Libraries
This project uses [lbry-redux](https://github.com/lbryio/lbry-redux) and [lbryionc](https://github.com/lbryio/lbryinc) to share Redux and LBRY API specific code with other LBRY apps. Over time, more Redux code that is suitable to be shared will be moved into lbry-redux. If modifying Redux code, you may be asked to make some of your changes in lbry-redux rather than lbry-desktop. The steps to work with lbry-redux locally can be found [here](https://github.com/lbryio/lbry-redux#local-development).
### Flow
[Flow](https://flow.org/) is a static type checker for JavaScript. Flow checks your code for
@ -155,13 +148,13 @@ There are a few tools integrated to the project that will ease the process of de
manner and, therefore, not begin working on anything reserved (or updated) within the last 3 days.
If someone has been officially assigned an issue via GitHub's assignment system, it is also not
available. Contributors are encouraged to ask if they have any questions about issue availability.
- The [changelog](https://github.com/lbryio/lbry-desktop/blob/master/CHANGELOG.md) should be updated to
- The [changelog](https://github.com/OdyseeTeam/odysee-frontend/blob/master/CHANGELOG.md) should be updated to
include a reference to the fix/change/addition. See previous entries for format.
- Once the pull request is visible in the LBRY repo, a LBRY team member will review it and make sure
- Once the pull request is visible in the Odysee repo, a Odysee team member will review it and make sure
it is up to our standards. At this point, the contributor may have to change his or her code based
on our suggestions and comments.
- Then, upon a satisfactory review of the code, we will merge it and send the contributor a tip (in
LBC) for the contribution.
Credits or Cash) for the contribution.
We are dedicated to being fair and friendly in this process. In **general**, level 4 issues will be
paid more than level 3 issues which will be paid more than level 2, and so on. However, this is not
@ -173,29 +166,20 @@ Also, we are here to enable you. We want you to succeed, so do not hesitate to a
need some information or assistance in completing an issue, please let us know! That is what we are
here for-- pushing development forward.
Lastly, don't feel limited by this list. Should LBRY have built-in Tor support? Add it! It's not in
Lastly, don't feel limited by this list. Should Odysee have built-in Tor support? Add it! It's not in
the issue tracker, but maybe it's a good idea. Do you think the search layout is unintuitive? Change
it! We welcome all feedback and suggestions. That said, it may be the case that we do not wish to
incorporate your change if you don't check with us first (also, please check with us especially if
you are planning on adding Tor support :P). If you want to add a feature that is not listed in the
issue tracker, go ahead and [create an issue](https://github.com/lbryio/lbry-desktop/issues/new), and
issue tracker, go ahead and [create an issue](https://github.com/OdyseeTeam/odysee-frontend/issues/new), and
say in the description that you would like to try to implement it yourself. This way we can tell you
in advance if we will accept your changes and we can point you in the right direction.
# Tom's "Voice of the User" Wishlist
[Anything marked with **both** "Help Wanted" and "Tom's 'Voice of the User' Wishlist"](https://github.com/lbryio/lbry-desktop/issues?q=is%3Aopen+is%3Aissue+label%3A%22Tom%27s+%5C%22Voice+of+the+User%5C%22+Wishlist%22+label%3A%22help+wanted%22+no%3Aassignee)
will earn you an extra 50 LBC on top of what we would otherwise tip you.
# Get in Touch
| Name | Role | Discord | Email |
| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------- |
| [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.com |
| [Sean](https://github.com/seanyesmunt) | The primary engineer working on the app. Feel free to ask any questions about the code. | sean | sean@lbry.com |
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------- |
| [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@Odysee.com |
| [Anthony](https://github.com/mayeaux) | The primary engineer working on the app. Feel free to ask any questions about the code. | Anthony | anthony.mayfield@odysee.com |
Join our Discord [here](https://chat.odysee.com/).
# More Information
More information about contributing to LBRY [here](https://lbry.tech/contribute).

18
package.json
View file

@ -1,22 +1,22 @@
{
"name": "lbry",
"version": "0.51.2",
"description": "A browser for the LBRY network, a digital marketplace controlled by its users.",
"name": "odysee.com",
"version": "0.0.0",
"description": "Explore a whole universe of videos on Odysee from regular people just like you!",
"keywords": [
"lbry"
"odysee"
],
"license": "MIT",
"homepage": "https://lbry.com/",
"homepage": "https://odysee.com",
"bugs": {
"url": "https://github.com/lbryio/lbry-desktop/issues"
"url": "https://github.com/OdyseeTeam/odysee-frontend/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/lbryio/lbry-desktop"
"url": "https://github.com/OdyseeTeam/odysee-frontend"
},
"author": {
"name": "LBRY Inc.",
"email": "hello@lbry.com"
"name": "Odysee Inc.",
"email": "hello@odysee.com"
},
"main": "./dist/electron/main.js",
"scripts": {

1
ui/analytics.js
View file

@ -329,7 +329,6 @@ const analytics: Analytics = {
claim_id: claimId,
};
// lbry.tv streams from AWS so we don't care about the time to start
if (timeToStart && !IS_WEB) {
params.time_to_start = timeToStart;
}

6
ui/component/inviteList/view.jsx
View file

@ -27,14 +27,14 @@ class InviteList extends React.PureComponent<Props> {
let rewardAmount = 0;
let rewardHelp = __(
"Woah, you have a lot of friends! You've claimed the maximum amount of invite rewards. Email %email% if you'd like to be whitelisted for more invites.",
{ email: 'hello@lbry.com' }
{ email: 'hello@odysee.com' }
);
if (referralReward) {
rewardAmount = referralReward.reward_amount;
rewardHelp = referralReward.reward_description;
}
const showClaimable = invitees.some(invite => invite.invite_reward_claimable && !invite.invite_reward_claimed);
const showClaimable = invitees.some((invite) => invite.invite_reward_claimable && !invite.invite_reward_claimed);
return (
<Card
@ -68,7 +68,7 @@ class InviteList extends React.PureComponent<Props> {
</tr>
</thead>
<tbody>
{invitees.map(invitee => (
{invitees.map((invitee) => (
<tr key={invitee.email}>
<td>{invitee.email}</td>
<td>

20
ui/component/publishFile/view.jsx
View file

@ -255,7 +255,7 @@ function PublishFile(props: Props) {
return (
<p className="help--error">
{UPLOAD_SIZE_MESSAGE}{' '}
<Button button="link" label={__('Upload Guide')} href="https://lbry.com/faq/video-publishing-guide" />
<Button button="link" label={__('Upload Guide')} href="https://odysee.com/@OdyseeHelp:b/uploadguide:1" />
</p>
);
}
@ -264,7 +264,11 @@ function PublishFile(props: Props) {
return (
<p className="help--warning">
{__('Your video has a bitrate over 5 Mbps. We suggest transcoding to provide viewers the best experience.')}{' '}
<Button button="link" label={__('Upload Guide')} href="https://odysee.com/@OdyseeHelp:b/uploadguide:1" />
<Button
button="link"
label={__('Upload Guide')}
href="https://odysee.com/@OdyseeHelp:b/uploadguide:1?lc=e280f6e6fdec3f5fd4043954c71add50b3fd2d6a9f3ddba979b459da6ae4a1f4"
/>
</p>
);
}
@ -275,7 +279,11 @@ function PublishFile(props: Props) {
{__(
'Your video may not be the best format. Use MP4s in H264/AAC format and a friendly bitrate (under 5 Mbps) and resolution (720p) for more reliable streaming.'
)}{' '}
<Button button="link" label={__('Upload Guide')} href="https://odysee.com/@OdyseeHelp:b/uploadguide:1" />
<Button
button="link"
label={__('Upload Guide')}
href="https://odysee.com/@OdyseeHelp:b/uploadguide:1?lc=e280f6e6fdec3f5fd4043954c71add50b3fd2d6a9f3ddba979b459da6ae4a1f4"
/>
</p>
);
}
@ -300,7 +308,11 @@ function PublishFile(props: Props) {
'For video content, use MP4s in H264/AAC format and a friendly bitrate (under 5 Mbps) and resolution (720p) for more reliable streaming. %SITE_NAME% uploads are restricted to %limit% GB.',
{ SITE_NAME, limit: TV_PUBLISH_SIZE_LIMIT_GB_STR }
)}{' '}
<Button button="link" label={__('Upload Guide')} href="https://lbry.com/faq/video-publishing-guide" />
<Button
button="link"
label={__('Upload Guide')}
href="https://odysee.com/@OdyseeHelp:b/uploadguide:1?lc=e280f6e6fdec3f5fd4043954c71add50b3fd2d6a9f3ddba979b459da6ae4a1f4"
/>
</p>
);
}

2
ui/component/repostCreate/view.jsx
View file

@ -352,7 +352,7 @@ function RepostCreate(props: Props) {
) : (
<span>
{__('Repost URL')}
<HelpLink href="https://lbry.com/faq/naming" />
<HelpLink href="https://odysee.com/@OdyseeHelp:b/trending:50" />
</span>
)}
</label>

2
ui/component/router/view.jsx
View file

@ -213,7 +213,7 @@ function AppRouter(props: Props) {
useEffect(() => {
const getDefaultTitle = (pathname: string) => {
const title = pathname.startsWith('/$/') ? PAGE_TITLE[pathname.substring(3)] : '';
return __(title) || (IS_WEB ? SITE_TITLE : 'LBRY');
return __(title) || (IS_WEB ? SITE_TITLE : 'Odysee');
};
if (uri) {

8
ui/component/syncPassword/view.jsx
View file

@ -75,7 +75,13 @@ function SyncPassword(props: Props) {
<p className="help">
<I18nMessage
tokens={{
help: <Button button="link" label={__('help guide')} href="https://lbry.com/faq/account-sync" />,
help: (
<Button
button="link"
label={__('help guide')}
href="https://odysee.com/@OdyseeHelp:b/OdyseeBasics:c"
/>
),
email: <Button button="link" href={`mailto:${SITE_HELP_EMAIL}`} label={`${SITE_HELP_EMAIL}`} />,
}}
>

6
ui/component/walletSendTip/view.jsx
View file

@ -263,7 +263,11 @@ function WalletSendTip(props: Props) {
<div className="section__subtitle">
{explainerText}
{/* {activeTab === TAB_FIAT && !hasCardSaved && <Button navigate={`/$/${PAGES.SETTINGS_STRIPE_CARD}`} label={__('Add A Card')} button="link" />} */}
<Button label={__('Learn more')} button="link" href="https://lbry.com/faq/tipping" />
<Button
label={__('Learn more')}
button="link"
href="https://odysee.com/@OdyseeHelp:b/Monetization-of-Content:3"
/>
</div>
</>
}

4
web/component/nag-degraded-performance.jsx
View file

@ -19,7 +19,9 @@ export default function NagDegradedPerformance(props: Props) {
<I18nMessage
tokens={{
DOMAIN,
more_information: <Button button="link" label={__('more')} href="https://status.lbry.com/" />,
more_information: (
<Button button="link" label={__('more')} href="https://odysee.com/@OdyseeHelp:b?view=about" />
),
}}
>
%DOMAIN% performance may be degraded. You can try to use it, or wait 5 minutes and refresh. Please no crush

16
web/package.json
View file

@ -1,22 +1,22 @@
{
"name": "lbry.tv",
"name": "odysee.com",
"version": "0.0.0",
"description": "A web based browser for the LBRY network, a digital marketplace controlled by its users.",
"description": "Explore a whole universe of videos on Odysee from regular people just like you!",
"keywords": [
"lbry"
"odysee"
],
"license": "MIT",
"homepage": "https://lbry.com/",
"homepage": "https://odysee.com",
"bugs": {
"url": "https://github.com/lbryio/lbry-desktop/issues"
"url": "https://github.com/OdyseeTeam/odysee-frontend/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/lbryio/lbry-desktop"
"url": "https://github.com/OdyseeTeam/odysee-frontend"
},
"author": {
"name": "LBRY Inc.",
"email": "hello@lbry.com"
"name": "Odysee Inc.",
"email": "hello@odysee.com"
},
"main": "./index.js",
"scripts": {