From 38144ca8a02e9b7d5d3a82f9dfd42de4cce16db8 Mon Sep 17 00:00:00 2001 From: felix920506 Date: Sun, 8 Sep 2024 15:31:19 -0400 Subject: [PATCH 01/17] add testing from master branch --- docs/general/testing/web/index.md | 47 +++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index e2e66923b..569b06ed8 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -34,3 +34,50 @@ in a completely transparent and auditable manner, **some of them may come from e By default, never trust any artifacts given by anyone outside the official channels if you can't inspect the source code first. They might compromise your system or track your activity! ::: + +## Testing from source code + +Jellfin Web can be hosted as a standalone application without being associated to a Jellyfin server. In that case, a separate Jellyfin server will need to be prepared. + +"Test server" below refers to the device hosting Jellyfin web in the test setup. + +### Prerequisites + +Below are a list of things to prepare before testing Jellyfin web + +- Have an instance of Jellyfin Server. +- Install [NodeJS, npm and nvm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) on the test server. +- Install [git](https://github.com/git-guides/install-git) on the test server. +- (Optional) Install [Github CLI](https://cli.github.com/) or [Github Desktop](https://github.com/apps/desktop) on the test server + +### Obtaining Jellyfin Web + +The Jellyfin Web source code can simply be cloned from the Github repository. +Instructions on how to do so can be found [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). + +### Checking out branches + +The `master` branch is where the unstable build is built from. If you wish to test over there, please checkout that branch. to checkout the `master` branch, simply do the following. + +- Git CLI, Github CLI: open a terminal in the web folder and run `git checkout master`. +- Github Desktop: Select the `master` branch in the branch dropdown menu. + +### Checking out PRs + +PRs are special branches submitted by contributors with the goal of eventually being merged into `master`. To checkout a PR, please follow the instructions below. + +1. Find the PR you would like to checkout in [the list of open PRs](https://github.com/jellyfin/jellyfin-web/pulls). +2. Checkout the PR. [Git CLI and Github CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [Github Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop) + +### Install Dependencies + +1. Navigate to the web directory (the folder containing the cloned contents of the repository) +2. Open a terminal window in the folder. +3. run `npm install` to install prerequisites. This will need to be done every time you switch to a new branch. + +### Start Development Server + +1. Open a terminal window in the folder +2. run `npm start` to start a development server. The server will start on port 8080. The server will auto update if the contents of the folder is changed. +3. Connect devices to this server to start testing. +4. Press `Ctrl+C` in the terminal window to stop the server. From 1a63c102d7021d3296545fc2b63bdbb0d349544e Mon Sep 17 00:00:00 2001 From: felix920506 Date: Tue, 10 Sep 2024 11:58:59 -0400 Subject: [PATCH 02/17] Add in jellyfin vue --- docs/general/testing/web/index.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index 569b06ed8..afb535e5f 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -37,18 +37,23 @@ They might compromise your system or track your activity! ## Testing from source code -Jellfin Web can be hosted as a standalone application without being associated to a Jellyfin server. In that case, a separate Jellyfin server will need to be prepared. +Jellyfin web clients can be hosted as a standalone application without being associated to a Jellyfin server. In that case, a separate Jellyfin server will need to be prepared. -"Test server" below refers to the device hosting Jellyfin web in the test setup. +"Test server" below refers to the device hosting the web client in the test setup. ### Prerequisites -Below are a list of things to prepare before testing Jellyfin web +Below are a list of things to prepare before testing Jellyfin web clients. -- Have an instance of Jellyfin Server. +- Have an instance of Jellyfin Server. A dedicated testing setup is recommended. - Install [NodeJS, npm and nvm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) on the test server. -- Install [git](https://github.com/git-guides/install-git) on the test server. +- Install [Git](https://github.com/git-guides/install-git) on the test server. - (Optional) Install [Github CLI](https://cli.github.com/) or [Github Desktop](https://github.com/apps/desktop) on the test server +- (Optional) A text editor or web IDE to make changes during testing, eg. [VSCode](https://code.visualstudio.com/), [Notepad++](https://notepad-plus-plus.org/) ,[Jetbrains Webstorm](https://www.jetbrains.com/webstorm/). + +:::note +Installing Github CLI or Github Desktop will automatically install Git on the system. +::: ### Obtaining Jellyfin Web @@ -66,8 +71,8 @@ The `master` branch is where the unstable build is built from. If you wish to te PRs are special branches submitted by contributors with the goal of eventually being merged into `master`. To checkout a PR, please follow the instructions below. -1. Find the PR you would like to checkout in [the list of open PRs](https://github.com/jellyfin/jellyfin-web/pulls). -2. Checkout the PR. [Git CLI and Github CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [Github Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop) +1. Find the PR you would like to checkout in the list of open PRs: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/pulls), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/pulls). +2. Checkout the PR in Git: [Git CLI and Github CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [Github Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop) ### Install Dependencies @@ -77,7 +82,7 @@ PRs are special branches submitted by contributors with the goal of eventually b ### Start Development Server -1. Open a terminal window in the folder -2. run `npm start` to start a development server. The server will start on port 8080. The server will auto update if the contents of the folder is changed. -3. Connect devices to this server to start testing. -4. Press `Ctrl+C` in the terminal window to stop the server. +1. Open a terminal window in the folder of the cloned contents. +2. run `npm start` to start a development server. Allow firewall access when prompted if you are using Windows. The server will start on port 8080 for Jellyfin Web and Port 3000 for Jellyfin Vue. The server will auto update if the contents of the folder is changed. +3. Connect client devices to the server using its IP address in order to start testing. You will need to connect a server manually. To use the demo instance, enter `https://demo.jellyfin.org/unstable` in the server address field. +4. When you have finished testing, or would like to switch to a different branch, press `Ctrl+C` in the terminal window to stop the server. From 51df5ebb7891e7e75f2c09f9e88c1e6a894ff701 Mon Sep 17 00:00:00 2001 From: felix920506 Date: Tue, 10 Sep 2024 12:04:57 -0400 Subject: [PATCH 03/17] missed item --- docs/general/testing/web/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index afb535e5f..5c279b846 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -55,9 +55,9 @@ Below are a list of things to prepare before testing Jellyfin web clients. Installing Github CLI or Github Desktop will automatically install Git on the system. ::: -### Obtaining Jellyfin Web +### Obtaining Source Code -The Jellyfin Web source code can simply be cloned from the Github repository. +The source code of the web clients can simply be cloned from their respective Github repositories: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/) Instructions on how to do so can be found [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). ### Checking out branches From 29fb85a49b8c251ed05dac6f663fd830e39f7835 Mon Sep 17 00:00:00 2001 From: felix920506 Date: Tue, 10 Sep 2024 15:41:39 -0400 Subject: [PATCH 04/17] link vue dev docs --- docs/general/testing/web/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index 5c279b846..2fcfff851 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -86,3 +86,5 @@ PRs are special branches submitted by contributors with the goal of eventually b 2. run `npm start` to start a development server. Allow firewall access when prompted if you are using Windows. The server will start on port 8080 for Jellyfin Web and Port 3000 for Jellyfin Vue. The server will auto update if the contents of the folder is changed. 3. Connect client devices to the server using its IP address in order to start testing. You will need to connect a server manually. To use the demo instance, enter `https://demo.jellyfin.org/unstable` in the server address field. 4. When you have finished testing, or would like to switch to a different branch, press `Ctrl+C` in the terminal window to stop the server. + +More info on how to setup Jellyfin Vue in a development environemt can be found [here](https://github.com/jellyfin/jellyfin-vue/wiki/Contributing#development-setup) From 6efdeefbeab214411b52d392504aa8db612962e1 Mon Sep 17 00:00:00 2001 From: felix920506 Date: Tue, 10 Sep 2024 15:56:22 -0400 Subject: [PATCH 05/17] fix spelling --- docs/general/testing/web/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index 2fcfff851..7553afcfd 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -87,4 +87,4 @@ PRs are special branches submitted by contributors with the goal of eventually b 3. Connect client devices to the server using its IP address in order to start testing. You will need to connect a server manually. To use the demo instance, enter `https://demo.jellyfin.org/unstable` in the server address field. 4. When you have finished testing, or would like to switch to a different branch, press `Ctrl+C` in the terminal window to stop the server. -More info on how to setup Jellyfin Vue in a development environemt can be found [here](https://github.com/jellyfin/jellyfin-vue/wiki/Contributing#development-setup) +More info on how to setup Jellyfin Vue in a development environment can be found [here](https://github.com/jellyfin/jellyfin-vue/wiki/Contributing#development-setup) From 7f993a46228ab516f4d2508419d31ddc24bd93ed Mon Sep 17 00:00:00 2001 From: felix920506 Date: Wed, 11 Sep 2024 14:50:08 -0400 Subject: [PATCH 06/17] typos --- docs/general/testing/web/index.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index 7553afcfd..9d212cf2e 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -37,18 +37,18 @@ They might compromise your system or track your activity! ## Testing from source code -Jellyfin web clients can be hosted as a standalone application without being associated to a Jellyfin server. In that case, a separate Jellyfin server will need to be prepared. +Jellyfin web clients can be hosted as a standalone application without being associated with a Jellyfin server. In that case, a separate Jellyfin server will need to be prepared. "Test server" below refers to the device hosting the web client in the test setup. ### Prerequisites -Below are a list of things to prepare before testing Jellyfin web clients. +Below is a list of things to prepare before testing Jellyfin web clients. - Have an instance of Jellyfin Server. A dedicated testing setup is recommended. - Install [NodeJS, npm and nvm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) on the test server. - Install [Git](https://github.com/git-guides/install-git) on the test server. -- (Optional) Install [Github CLI](https://cli.github.com/) or [Github Desktop](https://github.com/apps/desktop) on the test server +- (Optional) Install [GitHub CLI](https://cli.github.com/) or [GitHub Desktop](https://github.com/apps/desktop) on the test server - (Optional) A text editor or web IDE to make changes during testing, eg. [VSCode](https://code.visualstudio.com/), [Notepad++](https://notepad-plus-plus.org/) ,[Jetbrains Webstorm](https://www.jetbrains.com/webstorm/). :::note @@ -57,33 +57,33 @@ Installing Github CLI or Github Desktop will automatically install Git on the sy ### Obtaining Source Code -The source code of the web clients can simply be cloned from their respective Github repositories: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/) +The source code of the web clients can simply be cloned from their respective GitHub repositories: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/) Instructions on how to do so can be found [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). ### Checking out branches -The `master` branch is where the unstable build is built from. If you wish to test over there, please checkout that branch. to checkout the `master` branch, simply do the following. +The `master` branch is where the unstable build is built from. If you wish to test over there, please checkout that branch. To checkout the `master` branch, simply do the following. -- Git CLI, Github CLI: open a terminal in the web folder and run `git checkout master`. -- Github Desktop: Select the `master` branch in the branch dropdown menu. +- Git CLI, GitHub CLI: open a terminal in the web folder and run `git checkout master`. +- GitHub Desktop: Select the `master` branch in the branch dropdown menu. ### Checking out PRs PRs are special branches submitted by contributors with the goal of eventually being merged into `master`. To checkout a PR, please follow the instructions below. 1. Find the PR you would like to checkout in the list of open PRs: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/pulls), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/pulls). -2. Checkout the PR in Git: [Git CLI and Github CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [Github Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop) +2. Checkout the PR in Git: [Git CLI and GitHub CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [GitHub Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop) ### Install Dependencies 1. Navigate to the web directory (the folder containing the cloned contents of the repository) 2. Open a terminal window in the folder. -3. run `npm install` to install prerequisites. This will need to be done every time you switch to a new branch. +3. Run `npm install` to install dependencies. This will need to be done every time you switch to a new branch, as different branches might have different versions of dependencies. ### Start Development Server 1. Open a terminal window in the folder of the cloned contents. -2. run `npm start` to start a development server. Allow firewall access when prompted if you are using Windows. The server will start on port 8080 for Jellyfin Web and Port 3000 for Jellyfin Vue. The server will auto update if the contents of the folder is changed. +2. Run `npm start` to start a development server. Allow firewall access when prompted if you are using Windows. The server will start on port 8080 for Jellyfin Web and Port 3000 for Jellyfin Vue. The server will auto update if the contents of the folder is changed. 3. Connect client devices to the server using its IP address in order to start testing. You will need to connect a server manually. To use the demo instance, enter `https://demo.jellyfin.org/unstable` in the server address field. 4. When you have finished testing, or would like to switch to a different branch, press `Ctrl+C` in the terminal window to stop the server. From d9e3917199d3ff2bd81c3790cc87a33372207ab5 Mon Sep 17 00:00:00 2001 From: felix920506 Date: Wed, 11 Sep 2024 20:25:35 -0400 Subject: [PATCH 07/17] link client docs instead --- docs/general/testing/web/index.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index 9d212cf2e..0bebdeabd 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -74,17 +74,9 @@ PRs are special branches submitted by contributors with the goal of eventually b 1. Find the PR you would like to checkout in the list of open PRs: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/pulls), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/pulls). 2. Checkout the PR in Git: [Git CLI and GitHub CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [GitHub Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop) -### Install Dependencies +### Installing Dependencies and Starting a Development Server -1. Navigate to the web directory (the folder containing the cloned contents of the repository) -2. Open a terminal window in the folder. -3. Run `npm install` to install dependencies. This will need to be done every time you switch to a new branch, as different branches might have different versions of dependencies. +The web clients can be launched directly without being built. Please follow the instructions of the respective projects. -### Start Development Server - -1. Open a terminal window in the folder of the cloned contents. -2. Run `npm start` to start a development server. Allow firewall access when prompted if you are using Windows. The server will start on port 8080 for Jellyfin Web and Port 3000 for Jellyfin Vue. The server will auto update if the contents of the folder is changed. -3. Connect client devices to the server using its IP address in order to start testing. You will need to connect a server manually. To use the demo instance, enter `https://demo.jellyfin.org/unstable` in the server address field. -4. When you have finished testing, or would like to switch to a different branch, press `Ctrl+C` in the terminal window to stop the server. - -More info on how to setup Jellyfin Vue in a development environment can be found [here](https://github.com/jellyfin/jellyfin-vue/wiki/Contributing#development-setup) +For Jellyfin Web: Follow steps 2 and 3 of [these instructions](https://github.com/jellyfin/jellyfin-web?tab=readme-ov-file#getting-started) +For Jellyfin Vue: Follow steps 2 - 4 of [these instructions](https://github.com/jellyfin/jellyfin-vue/wiki/Contributing#frontend) From 03023d6ca9977816e3dffd8b35f7d630a33bb649 Mon Sep 17 00:00:00 2001 From: felix920506 Date: Wed, 11 Sep 2024 20:26:54 -0400 Subject: [PATCH 08/17] pull request --- docs/general/testing/web/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index 0bebdeabd..ebb074ccb 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -67,12 +67,12 @@ The `master` branch is where the unstable build is built from. If you wish to te - Git CLI, GitHub CLI: open a terminal in the web folder and run `git checkout master`. - GitHub Desktop: Select the `master` branch in the branch dropdown menu. -### Checking out PRs +### Checking out pull requests -PRs are special branches submitted by contributors with the goal of eventually being merged into `master`. To checkout a PR, please follow the instructions below. +Pull requests are special branches submitted by contributors with the goal of eventually being merged into `master`. To checkout a pull request, please follow the instructions below. -1. Find the PR you would like to checkout in the list of open PRs: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/pulls), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/pulls). -2. Checkout the PR in Git: [Git CLI and GitHub CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [GitHub Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop) +1. Find the pull request you would like to checkout in the list of open pull requests: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/pulls), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/pulls). +2. Checkout the pull request in Git: [Git CLI and GitHub CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [GitHub Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop) ### Installing Dependencies and Starting a Development Server From 164aea2f60290ea696221a0d7661b9b43bbb72b6 Mon Sep 17 00:00:00 2001 From: felix920506 Date: Wed, 11 Sep 2024 20:20:28 -0400 Subject: [PATCH 09/17] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fernando Fernández --- docs/general/testing/web/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index ebb074ccb..1afafc427 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -37,7 +37,7 @@ They might compromise your system or track your activity! ## Testing from source code -Jellyfin web clients can be hosted as a standalone application without being associated with a Jellyfin server. In that case, a separate Jellyfin server will need to be prepared. +Jellyfin web clients can be hosted as a standalone application without being associated with a Jellyfin server. In that case, a separate Jellyfin server will be needed. "Test server" below refers to the device hosting the web client in the test setup. @@ -49,7 +49,7 @@ Below is a list of things to prepare before testing Jellyfin web clients. - Install [NodeJS, npm and nvm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) on the test server. - Install [Git](https://github.com/git-guides/install-git) on the test server. - (Optional) Install [GitHub CLI](https://cli.github.com/) or [GitHub Desktop](https://github.com/apps/desktop) on the test server -- (Optional) A text editor or web IDE to make changes during testing, eg. [VSCode](https://code.visualstudio.com/), [Notepad++](https://notepad-plus-plus.org/) ,[Jetbrains Webstorm](https://www.jetbrains.com/webstorm/). +- (Optional) A text editor or web IDE to make changes during testing, eg. [VSCode](https://code.visualstudio.com/), [Notepad++](https://notepad-plus-plus.org/), [Jetbrains Webstorm](https://www.jetbrains.com/webstorm/). :::note Installing Github CLI or Github Desktop will automatically install Git on the system. From f152a1bdf48f3b7fb624dd297103c7f7fd3e2da6 Mon Sep 17 00:00:00 2001 From: felix920506 Date: Wed, 11 Sep 2024 20:29:28 -0400 Subject: [PATCH 10/17] Update index.md --- docs/general/testing/web/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index 1afafc427..d80abcd55 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -76,7 +76,9 @@ Pull requests are special branches submitted by contributors with the goal of ev ### Installing Dependencies and Starting a Development Server -The web clients can be launched directly without being built. Please follow the instructions of the respective projects. +The web clients can be launched directly without being built. Please open a terminal window in the folder with the cloned contents of the clients, then follow the instructions of the respective projects. For Jellyfin Web: Follow steps 2 and 3 of [these instructions](https://github.com/jellyfin/jellyfin-web?tab=readme-ov-file#getting-started) For Jellyfin Vue: Follow steps 2 - 4 of [these instructions](https://github.com/jellyfin/jellyfin-vue/wiki/Contributing#frontend) + +To exit the development server, simply press `Ctrl+C` in the terminal window. From 98ec5e1e3b6285dadcb9d430fbe7458ec63ce4a3 Mon Sep 17 00:00:00 2001 From: felix920506 Date: Thu, 12 Sep 2024 14:06:13 -0400 Subject: [PATCH 11/17] Apply suggestions from code review Co-authored-by: Bill Thornton --- docs/general/testing/web/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index d80abcd55..c13a7dab4 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -48,7 +48,7 @@ Below is a list of things to prepare before testing Jellyfin web clients. - Have an instance of Jellyfin Server. A dedicated testing setup is recommended. - Install [NodeJS, npm and nvm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) on the test server. - Install [Git](https://github.com/git-guides/install-git) on the test server. -- (Optional) Install [GitHub CLI](https://cli.github.com/) or [GitHub Desktop](https://github.com/apps/desktop) on the test server +- (Optional) Install [GitHub CLI](https://cli.github.com/) or [GitHub Desktop](https://github.com/apps/desktop) on the test server. - (Optional) A text editor or web IDE to make changes during testing, eg. [VSCode](https://code.visualstudio.com/), [Notepad++](https://notepad-plus-plus.org/), [Jetbrains Webstorm](https://www.jetbrains.com/webstorm/). :::note @@ -57,7 +57,7 @@ Installing Github CLI or Github Desktop will automatically install Git on the sy ### Obtaining Source Code -The source code of the web clients can simply be cloned from their respective GitHub repositories: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/) +The source code of the web clients can be cloned from their respective GitHub repositories: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/). Instructions on how to do so can be found [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). ### Checking out branches @@ -72,7 +72,7 @@ The `master` branch is where the unstable build is built from. If you wish to te Pull requests are special branches submitted by contributors with the goal of eventually being merged into `master`. To checkout a pull request, please follow the instructions below. 1. Find the pull request you would like to checkout in the list of open pull requests: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/pulls), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/pulls). -2. Checkout the pull request in Git: [Git CLI and GitHub CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [GitHub Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop) +2. Checkout the pull request in Git: [Git CLI and GitHub CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [GitHub Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop). ### Installing Dependencies and Starting a Development Server From f6512d45e6db64c8a2951890126af25075fe6cd5 Mon Sep 17 00:00:00 2001 From: felix920506 Date: Thu, 12 Sep 2024 14:09:38 -0400 Subject: [PATCH 12/17] capitalization --- docs/general/testing/web/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index c13a7dab4..dfa3889bf 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -55,7 +55,7 @@ Below is a list of things to prepare before testing Jellyfin web clients. Installing Github CLI or Github Desktop will automatically install Git on the system. ::: -### Obtaining Source Code +### Obtaining source code The source code of the web clients can be cloned from their respective GitHub repositories: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/). Instructions on how to do so can be found [here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). @@ -74,7 +74,7 @@ Pull requests are special branches submitted by contributors with the goal of ev 1. Find the pull request you would like to checkout in the list of open pull requests: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/pulls), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/pulls). 2. Checkout the pull request in Git: [Git CLI and GitHub CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [GitHub Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop). -### Installing Dependencies and Starting a Development Server +### Installing dependencies and starting a development server The web clients can be launched directly without being built. Please open a terminal window in the folder with the cloned contents of the clients, then follow the instructions of the respective projects. From 2b5c9c48171b7aec930ca3d7c4934ac7d976f7ba Mon Sep 17 00:00:00 2001 From: felix920506 Date: Thu, 12 Sep 2024 14:12:32 -0400 Subject: [PATCH 13/17] reword master --- docs/general/testing/web/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index dfa3889bf..f95c49207 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -62,7 +62,7 @@ Instructions on how to do so can be found [here](https://docs.github.com/en/repo ### Checking out branches -The `master` branch is where the unstable build is built from. If you wish to test over there, please checkout that branch. To checkout the `master` branch, simply do the following. +The `master` branch is the default branch and where the unstable build is built from. After cloning, it will be checked out by default. If you wish to go back to testing the `master` branch after testing pull requests, please checkout the `master` branch. To checkout the `master` branch, simply do the following: - Git CLI, GitHub CLI: open a terminal in the web folder and run `git checkout master`. - GitHub Desktop: Select the `master` branch in the branch dropdown menu. From 6371ae6e37c670484882e6a7992e657f70833aba Mon Sep 17 00:00:00 2001 From: felix920506 Date: Thu, 12 Sep 2024 14:17:55 -0400 Subject: [PATCH 14/17] Add update docs --- docs/general/testing/web/index.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index f95c49207..30fed98d5 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -74,6 +74,13 @@ Pull requests are special branches submitted by contributors with the goal of ev 1. Find the pull request you would like to checkout in the list of open pull requests: [Jellyfin Web](https://github.com/jellyfin/jellyfin-web/pulls), [Jellyfin Vue](https://github.com/jellyfin/jellyfin-vue/pulls). 2. Checkout the pull request in Git: [Git CLI and GitHub CLI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally), [GitHub Desktop](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop). +### Pulling latest changes + +Branches won't be updated automatically by default. If it has been a while since you last pulled latest changes, the source code you have might be out of date. To pull in the latest changes, follow the instructions below: + +- Git CLI and GitHub CLI: Open a terminal window and run the command `git pull` +- GitHub Desktop: Follow [these instructions from GitHub](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop#pulling-to-your-local-branch-from-the-remote) + ### Installing dependencies and starting a development server The web clients can be launched directly without being built. Please open a terminal window in the folder with the cloned contents of the clients, then follow the instructions of the respective projects. From 2c8c9ff5b5b134f83ee3465b69d5c2f34906dedc Mon Sep 17 00:00:00 2001 From: felix920506 Date: Thu, 12 Sep 2024 14:19:09 -0400 Subject: [PATCH 15/17] minor wording changes --- docs/general/testing/web/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index 30fed98d5..a106e2b4e 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -78,8 +78,8 @@ Pull requests are special branches submitted by contributors with the goal of ev Branches won't be updated automatically by default. If it has been a while since you last pulled latest changes, the source code you have might be out of date. To pull in the latest changes, follow the instructions below: -- Git CLI and GitHub CLI: Open a terminal window and run the command `git pull` -- GitHub Desktop: Follow [these instructions from GitHub](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop#pulling-to-your-local-branch-from-the-remote) +- Git CLI and GitHub CLI: Open a terminal window in the folder with the cloned contents of the clients and run the command `git pull`. +- GitHub Desktop: Follow [these instructions from GitHub](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/syncing-your-branch-in-github-desktop#pulling-to-your-local-branch-from-the-remote). ### Installing dependencies and starting a development server From 118445336302f7165c8166085a09e583e000d554 Mon Sep 17 00:00:00 2001 From: felix920506 Date: Thu, 12 Sep 2024 14:23:06 -0400 Subject: [PATCH 16/17] change nodejs install instructions --- docs/general/testing/web/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index a106e2b4e..7465d37bf 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -46,8 +46,9 @@ Jellyfin web clients can be hosted as a standalone application without being ass Below is a list of things to prepare before testing Jellyfin web clients. - Have an instance of Jellyfin Server. A dedicated testing setup is recommended. -- Install [NodeJS, npm and nvm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) on the test server. +- Install the latest **LTS** version of [NodeJS and npm](https://nodejs.org/en/download/) on the test server. - Install [Git](https://github.com/git-guides/install-git) on the test server. +- (Optional) Install nvm: [macOS, Linux](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating), [Windows](https://github.com/coreybutler/nvm-windows) - (Optional) Install [GitHub CLI](https://cli.github.com/) or [GitHub Desktop](https://github.com/apps/desktop) on the test server. - (Optional) A text editor or web IDE to make changes during testing, eg. [VSCode](https://code.visualstudio.com/), [Notepad++](https://notepad-plus-plus.org/), [Jetbrains Webstorm](https://www.jetbrains.com/webstorm/). From 5e3905681c084eb6374e8bb44be33733f9be7aed Mon Sep 17 00:00:00 2001 From: felix920506 Date: Tue, 17 Sep 2024 23:55:26 +0800 Subject: [PATCH 17/17] reviews Co-authored-by: Bill Thornton --- docs/general/testing/web/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/general/testing/web/index.md b/docs/general/testing/web/index.md index 7465d37bf..3f06590ca 100644 --- a/docs/general/testing/web/index.md +++ b/docs/general/testing/web/index.md @@ -48,7 +48,7 @@ Below is a list of things to prepare before testing Jellyfin web clients. - Have an instance of Jellyfin Server. A dedicated testing setup is recommended. - Install the latest **LTS** version of [NodeJS and npm](https://nodejs.org/en/download/) on the test server. - Install [Git](https://github.com/git-guides/install-git) on the test server. -- (Optional) Install nvm: [macOS, Linux](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating), [Windows](https://github.com/coreybutler/nvm-windows) +- (Optional) Install nvm: [macOS, Linux](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating), [Windows](https://github.com/coreybutler/nvm-windows). - (Optional) Install [GitHub CLI](https://cli.github.com/) or [GitHub Desktop](https://github.com/apps/desktop) on the test server. - (Optional) A text editor or web IDE to make changes during testing, eg. [VSCode](https://code.visualstudio.com/), [Notepad++](https://notepad-plus-plus.org/), [Jetbrains Webstorm](https://www.jetbrains.com/webstorm/).