Typo + some information

This commit is contained in:
bfry 2022-03-14 20:59:38 +01:00
parent bb07561bde
commit b9d0299f20
3 changed files with 7 additions and 3 deletions

View File

@ -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
},

View File

@ -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!

View File

@ -32,3 +32,6 @@ Also, YouTube Vanced just shut down
<img src="https://github.com/Frontesque/VueTube/raw/main/Icons/screenshots/update_manager.png" alt="VueTube Update Manager" width="400"/>
<img src="https://github.com/Frontesque/VueTube/raw/main/Icons/screenshots/settings.png" alt="VueTube Settings" width="400"/>
## Want to contribute?
Please read [this](contributing.md) for some more information to get started.