Want to contribute? Awesome. We love contributors.
Fork then clone the repo:
git clone [email protected]:your-username/youtube_desktop.git
You will need to create your own Youtube Api Key. Here is the link on how to get your own keys.
Below is a sample api_keys.js file that is in .gitignore. Please make your own version of this javascript file and name it api_keys.js and you will be able to run this project.
module.exports = {
publicDataKey: 'your public data key',
clientId: 'your client id',
clientSecret: 'your client secret'
};Create a new branch:
git checkout -b awesome-feature
Install the necessary dependencies (you can use npm or yarn:
npm install
Let webpack create the bundle files and watch for changes:
npm run watch
Start up the electron window in a separate terminal:
npm run start
Make or add changes, commit your changes:
git add -A;
git commit -m 'Awesome new feature';
Make sure to run the necessary tests and lints and fix any errors:
npm run lint;
Push up to Github:
git push origin awesome-feature;
Create a Pull Request, add appropriate label(s).
Congratulations! You are done. Just wait for us to review your code.
Please click here to report an issue or request a new feature.
See Git Instructions on how to:
- pull remote branches that are not on local repo.
- fast forward branches that are behind the master.
- stash and un-stash uncommitted changes