From b9d0299f2024eb2e9ec9c483ddc82c5252b05ff4 Mon Sep 17 00:00:00 2001 From: bfry Date: Mon, 14 Mar 2022 20:59:38 +0100 Subject: [PATCH] Typo + some information --- NUXT/nuxt.config.js | 2 +- contributing.md | 5 +++-- readme.md | 3 +++ 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/NUXT/nuxt.config.js b/NUXT/nuxt.config.js index bf14997..e6aee45 100644 --- a/NUXT/nuxt.config.js +++ b/NUXT/nuxt.config.js @@ -25,7 +25,7 @@ export default { //--- Bettertube Debugging ---// server: { - port: 80, // default: 3000 + port: 80, // default: 3000 (Note: Running on ports below 1024 requires root privileges!) host: '0.0.0.0', // default: localhost, timing: false }, diff --git a/contributing.md b/contributing.md index 30e7271..ab7ac54 100644 --- a/contributing.md +++ b/contributing.md @@ -1,5 +1,5 @@ # Contributing to VueTube -Hello! First of all, I'd like to say thank you for your interest in contribuiting to the VueTube project. If you haven't already, I'd like to extend to you a warm welcome to our [Discord server](https://discord.gg/7P8KJrdd5W). Hopefully this page will help make the contributing experience as seemless as possible. +Hello! First of all, I'd like to say thank you for your interest in contributing to the VueTube project. If you haven't already, I'd like to extend to you a warm welcome to our [Discord server](https://discord.gg/7P8KJrdd5W). Hopefully this page will help make the contributing experience as seamless as possible. # Prerequisites - Android Studio "Arctic Fox" or Later - [Download](https://developer.android.com/studio#downloads) @@ -9,12 +9,13 @@ Hello! First of all, I'd like to say thank you for your interest in contribuitin - (Optional) Xcode [iOS app development] - [Download](https://developer.apple.com/xcode/) # Setup -Now that you have everything installed, you can proceed with installing your node dependancies. You can do this with the following commands in the project's root directory: +Now that you have everything installed, you can proceed with installing your node dependencies. You can do this with the following commands in the project's root directory: `npm i; cd NUXT; npm i; cd ..` # Testing If you wish to test the app within your browser, you can enter the `NUXT` directory, and run `npm run dev`. You can then navigate to `http://localhost:80/` in your favorite web browser. > NOTE: TESTING THE APPLICATION FROM WITHIN YOUR WEB BROWSER DISALLOWS SOME FEATURES FROM WORKING. PLEASE COMPILE TO YOUR ANDROID DEVICE BEFORE SUBMITTING YOUR PULL REQUEST +> NOTE2: If you get an error about `EACCES: permission denied 0.0.0.0:80`, change the port in `nuxt.config.js` back to 3000. If you're done with your changes and are ready to submit your code, there is one last step: compiling to your android device. Plug in your Android or iOS device. Then, in the root directory of the project, run `npx cap run android` to test on your Android device or `npx cap run ios` to test on your iPhone. The app will proceed to build and you will be asked what device to install the debug application on. Select your device and wait as it compiles for you! Hopefully everything goes smoothy, and you are ready to make your pull request! diff --git a/readme.md b/readme.md index c5a070e..0b354b3 100644 --- a/readme.md +++ b/readme.md @@ -32,3 +32,6 @@ Also, YouTube Vanced just shut down VueTube Update Manager VueTube Settings + +## Want to contribute? +Please read [this](contributing.md) for some more information to get started. \ No newline at end of file