TheLanc3/YoutubeDL-Material
1
0
Fork 0
mirror of https://github.com/Tzahi12345/YoutubeDL-Material.git synced 2026-03-07 12:00:01 +03:00
Code Issues Packages Projects Releases Wiki Activity
Page: Contributing
Pages
API Archive Categories Configuration Contributing Environment Variables Firefox Extension Fixing 429 errors Home Notifications RSS Feed Raspberry Pi 4 Reverse Proxy Setup Setting a MongoDB backend to use as database provider for YTDL M Synology Translate iOS Shortcuts Workflow unRAID
Clone
3
Contributing
Tzahi12345 edited this page 2023-12-03 20:00:46 -05:00
Table of Contents

Here are the official contributing guidelines! The following sections are included:

Codespaces

The easiest way to test new code is to open the branch in a GitHub Codespace.

  1. Wait for the npm install to finish post creation
  2. In one terminal, run npm run codespaces to start the frontend
  3. In another terminal, navigate to backend and run npm run debug to start the backend
  4. You may need to set the ports to public, but otherwise it should be accessible at the 4200 port.

Getting set up

  1. First, make sure you have Node.js installed. You will need it to do both backend and frontend development.
  2. Install the Angular CLI: npm install -g @angular/cli. This will be immensely helpful in working with Angular.
  3. Clone the repository if you haven't already: git clone https://github.com/Tzahi12345/YoutubeDL-Material.git

Starting the frontend

Note: Make sure you are in the root directory of the app!

  1. Run ng serve. This will start the frontend dev server, and you will be able to access it by going to http://localhost:4200 in your web browser.
  2. That's it! If you save a file, the dev server will automatically restart and you'll be able to immediately see your code changes. Now make sure your backend is up and running :)

Starting the backend

  1. Go into the backend directory, which you can find in the root folder.
  2. Set the env var YTDL_MODE to debug. On Linux you can generally run export YTDL_MODE="debug", and on Windows run set YTDL_MODE=debug
  3. Finally, run node app.js to run the backend server. You're all set! To see backend code updates, restart the server.

Frontend

Code Overview

This section is WIP.

General rules

Variables are generally named using snake case, which in short is just undercase with words separated by an underscore

  • Example: let this_is_a_variable = true
  • Don't specify the type unless the variable is set to null by default
    • Example: let this_is_a_variable: boolean = null

The frontend is split up into various components, so if you are ever adding functionality that could logically fit into a separate component, please do so. Add new components to the src/app/components directory, or if the component is exclusively a dialog, place it in the src/app/dialogs directory.

All API calls should be done through posts.services.ts, also called PostsService. This service also keeps track of the config and current user info.

Translations

If you add any strings to the frontend that will appear in the UI, make sure to make it translatable. How you do so depends on where the string exists (purely in HTML or in TypeScript), these next two subsections will explain how to do so.

Once you are done adding translations, run ng xi18n --output-path assets/i18n from the root directory to re-generate the needed XLIFF source file. This will be called messages.xlf, but rename it to messages.en.xlf to indicate that it is the new English source file.

HTML strings

Let's say you have the following HTML element:

<span>This is a string I want to translate.</span>

To make it translatable, surround the string with an <ng-container> element like so:

<span><ng-container i18n="String description">This is a string I want to translate.</ng-container></span>

That's all!

TypeScript strings

To properly translate strings that are defined in TypeScript, the Select ICU must be used in the corresponding HTML. You can see where we do this in settings.component.html

<span i18n="Settings cancel and close button">{settingsAreTheSame + "", select, true {Close} false {Cancel}}</span>`

The brackets are the important part here, encasing an "if statement" for the translatable strings.

If the settings have changed, the button will have the "Cancel" label, but if they haven't changed, it'll just say "Close". The + "" after settingsAreTheSame is just to convert the boolean variable into a string, since the ICU select comparisons are string to string.

Backend (WIP)

Code Overview (WIP)

This section is WIP.

General rules (WIP)

This section is WIP.