Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancing the README.md for the Video-Hub-App #765

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
+59 −0
Open

Enhancing the README.md for the Video-Hub-App #765

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c122776
Update README.md
tmiyazumi Sep 11, 2022
ac510c3
Update README.md
tmiyazumi Sep 11, 2022
4394ee9
Merge pull request #1 from tmiyazumi/tmiyazumi-patch-1
tmiyazumi Sep 11, 2022
3d60e8c
Merge branch 'whyboris:main' into main
tmiyazumi Nov 13, 2022
a7650fa
test
tmiyazumi Nov 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,17 @@ $3.50 of every sale goes to the [_cost-effective_](https://www.givewell.org/char

![video-hub-app](https://user-images.githubusercontent.com/17264277/82097107-3ed91700-96d0-11ea-8679-87fa3e07cd0b.jpg)

This should be the landing screen of the videohub.
<img width="851" alt="Screen Shot 2022-09-11 at 5 25 41 PM" src="https://user-images.githubusercontent.com/56640569/189549489-92716b53-7a98-4881-a799-6a932e661ec6.png">

### Mac OS
If you are having issues with the downloading process access issues. Follow these steps:
- Choose Apple menu > System Preferences, click Security & Privacy , then click General.
- Click on the Lock to change Security Settings.
- Allow system from opening Video-Hub-App

<img width="659" alt="Screen Shot 2022-09-11 at 5 28 51 PM" src="https://user-images.githubusercontent.com/56640569/189549592-7da8df5a-0c04-455c-829f-e51e1d2456b1.png">


## About

Expand Down Expand Up @@ -40,6 +51,17 @@ See [issues](https://github.com/whyboris/Video-Hub-App/issues) for what is in pr

⚠ The repository is usually ahead of the publicly [released version](https://github.com/whyboris/Video-Hub-App/releases) - it is 🚧 WIP and may have bugs in it.

### Download Node:

<i>Skip this step if you have the latest Node downloaded.</i>

- Navigate and download Node for your correct Operating System: https://nodejs.org/en/download/

Check if you have Node downloaded by running this command
```
npm --version
```

How to start:

- `npm install` to install
Expand Down
13 changes: 13 additions & 0 deletions i18n/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,23 @@

Thank you for considering adding an additional translation to Video Hub App!

# Setup
Translations take seconds using the _Google Translation API_ and the [translate-json-object](https://github.com/KhaledMohamedP/translate-json-object) library, but it does require a _Google Cloud API_ key (please use your own).

### How to get Google Could API Key
Copy link

@krisu5 krisu5 Nov 1, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling mistake: Could should be Cloud

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the catch!

Navigate to the following [Wesbite](https://console.cloud.google.com/apis/credentials)

Log into your Google account and navigate to the "create credentials" section.
<img width="455" alt="Screen Shot 2022-09-11 at 4 47 28 PM" src="https://user-images.githubusercontent.com/56640569/189548240-ae30d21b-52cd-49fb-bf5d-bcbb235db063.png">

<i> <b>Note </b>: Do not embed API keys directly in code: API keys that are embedded in code can be accidentally exposed to the public, for example, if you forget to remove the keys from code that you share. Instead of embedding your API keys in your applications, store them in environment variables or in files outside of your application's source tree. </i>

Add those changes to your local repository!

Simply `cd i18n`, edit the `translate.js` file there to include your key and the target language abbreviation (e.g. `en`), and run (`node translate.js`).

<img width="518" alt="Screen Shot 2022-09-11 at 4 49 54 PM" src="https://user-images.githubusercontent.com/56640569/189548308-83ac27bf-bab7-46f0-9e23-80749d53bfa8.png">

For abbreviations please choose a 2-letter abbreviation that is on both lists:
- https://github.com/electron/electron/blob/master/docs/api/locales.md
- https://cloud.google.com/translate/docs/languages
Expand Down