diff --git a/docs/development/build-instructions.md b/docs/development/build-instructions.md index 8cb30a0dc..3d90b574c 100644 --- a/docs/development/build-instructions.md +++ b/docs/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: * Maven * [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/docs/development/development.md b/docs/development/development.md new file mode 100644 index 000000000..f583ad71c --- /dev/null +++ b/docs/development/development.md @@ -0,0 +1,101 @@ +# Development + + This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +* [Set up your machine for GitHub development](https://support.github.com/) + +* Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +* Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +* Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +* Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +* In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +* Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +* Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +* Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +* Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/af-ZA/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/af-ZA/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/af-ZA/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/af-ZA/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/af-ZA/docusaurus-plugin-content-docs/current/development/development.md b/i18n/af-ZA/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/af-ZA/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/ar-SA/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/ar-SA/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/ar-SA/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/ar-SA/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/ar-SA/docusaurus-plugin-content-docs/current/development/development.md b/i18n/ar-SA/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/ar-SA/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/bg-BG/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/bg-BG/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/bg-BG/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/bg-BG/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/bg-BG/docusaurus-plugin-content-docs/current/development/development.md b/i18n/bg-BG/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/bg-BG/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/ca-ES/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/ca-ES/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/ca-ES/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/ca-ES/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/ca-ES/docusaurus-plugin-content-docs/current/development/development.md b/i18n/ca-ES/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/ca-ES/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/cs-CZ/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/cs-CZ/docusaurus-plugin-content-docs/current/development/build-instructions.md index ccf457923..2f8cf265b 100644 --- a/i18n/cs-CZ/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/cs-CZ/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,8 +12,6 @@ Jsou vyžadovány následující balíčky programů: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -V sekci [plné instrukce] (#full-instructions) najdete kompletní vysvětlení jak instalovat všechen potřebný software a jak vytvořit UMS pro každý operační systém. - # Krátké pokyny Pokud jsou nainstalovány všechny požadované balíky, následující příkazy diff --git a/i18n/cs-CZ/docusaurus-plugin-content-docs/current/development/development.md b/i18n/cs-CZ/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..820182cf0 --- /dev/null +++ b/i18n/cs-CZ/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Rozvoj + +Tento dokument vysvětluje, jak provést a spustit vlastní změny. + +## Stáhněte kód na svůj počítač + +GitHub velmi zjednodušuje vývojářům oddělit svou vlastní verzi oficiálních zdrojů UMS a přidávat vlastní vylepšení nebo funkce. GitHub usnadňuje odeslání těchto funkcí jako "Pull Requests" oficiálnímu vývojovému týmu UMS. + +- [Nastavte svůj stroj pro vývoj GitHubu] (https://support.github.com/) + +- Přejděte na [GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) a stiskněte tlačítko `Fork` vpravo nahoře. + +- Klonujte nový GitHub repozitář do vašeho lokálního počítače. URL klonu lze vidět + na hlavní stránce vašeho repozitáře. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +Nyní máte nový repozitář na vašem lokálním počítači. + +## Vývoj s IDE + +### [VS kód](https://code.visualstudio.com/) + +To je náš doporučený editor, protože je skvělý jak pro Javu, tak pro TypeScript, naše dva hlavní jazyky. + +#### Java server + +Když otevřete kód, pravděpodobně uvidíte některá doporučení k instalaci rozšíření, například `Extension Pack for Java`. Nainstalujte jej. +Když je toto nainstalováno a nakonfigurováno, můžete spustit Java server kliknutím na horní tlačítko `Run -> Start Debugging`, a znovu načíst pomocí `Run -> Restart Debugging`. Tyto příkazy by měly být dokončeny do 1 sekundy pro rychlý vývojový pracovní postup. + +#### Webová rozhraní prohlížeče + +Pokud chcete provést změny v našem webovém prohlížeči, budete muset spustit React server, který se bude starat o kompilaci a obsluhu kódu TypeScript. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/da-DK/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/da-DK/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/da-DK/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/da-DK/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/da-DK/docusaurus-plugin-content-docs/current/development/development.md b/i18n/da-DK/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/da-DK/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/de-DE/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/de-DE/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/de-DE/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/de-DE/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/de-DE/docusaurus-plugin-content-docs/current/development/development.md b/i18n/de-DE/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/de-DE/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/el-GR/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/el-GR/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/el-GR/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/el-GR/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/el-GR/docusaurus-plugin-content-docs/current/development/development.md b/i18n/el-GR/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/el-GR/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/en-GB/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/en-GB/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/en-GB/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/en-GB/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/en-GB/docusaurus-plugin-content-docs/current/development/development.md b/i18n/en-GB/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/en-GB/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/es-ES/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/es-ES/docusaurus-plugin-content-docs/current/development/build-instructions.md index e993b9899..05dc3d903 100644 --- a/i18n/es-ES/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/es-ES/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,8 +12,6 @@ Se requieren los siguientes paquetes de software: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Lea la sección [Instrucciones completas](#full-instructions) para obtener una explicación completa de cómo instalar todo el software necesario y cómo compilar UMS para cada sistema operativo. - # Instrucciones cortas Si se han instalado todos los paquetes de software requeridos, los siguientes comandos descargarán el código fuente más reciente y la compilación UMS: diff --git a/i18n/es-ES/docusaurus-plugin-content-docs/current/development/development.md b/i18n/es-ES/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/es-ES/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/et-EE/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/et-EE/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/et-EE/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/et-EE/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/et-EE/docusaurus-plugin-content-docs/current/development/development.md b/i18n/et-EE/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/et-EE/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/fa-IR/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/fa-IR/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/fa-IR/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/fa-IR/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/fa-IR/docusaurus-plugin-content-docs/current/development/development.md b/i18n/fa-IR/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/fa-IR/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/fi-FI/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/fi-FI/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/fi-FI/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/fi-FI/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/fi-FI/docusaurus-plugin-content-docs/current/development/development.md b/i18n/fi-FI/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/fi-FI/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/fr-FR/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/fr-FR/docusaurus-plugin-content-docs/current/development/build-instructions.md index a7b9bca9e..94f4bdb06 100644 --- a/i18n/fr-FR/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/fr-FR/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ Les progiciels suivants sont requis : - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Lisez la section [Instructions complètes] (#full-instructions) pour une explication complète de la façon dont -installer tous les logiciels nécessaires et comment construire UMS pour chaque système d'exploitation. - # Instructions de construction Si tous les paquets logiciels nécessaires sont installés, les commandes suivantes diff --git a/i18n/fr-FR/docusaurus-plugin-content-docs/current/development/development.md b/i18n/fr-FR/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/fr-FR/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/he-IL/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/he-IL/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/he-IL/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/he-IL/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/he-IL/docusaurus-plugin-content-docs/current/development/development.md b/i18n/he-IL/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/he-IL/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/hr-HR/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/hr-HR/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/hr-HR/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/hr-HR/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/hr-HR/docusaurus-plugin-content-docs/current/development/development.md b/i18n/hr-HR/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/hr-HR/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/hu-HU/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/hu-HU/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/hu-HU/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/hu-HU/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/hu-HU/docusaurus-plugin-content-docs/current/development/development.md b/i18n/hu-HU/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/hu-HU/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/is-IS/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/is-IS/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/is-IS/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/is-IS/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/is-IS/docusaurus-plugin-content-docs/current/development/development.md b/i18n/is-IS/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/is-IS/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/it-IT/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/it-IT/docusaurus-plugin-content-docs/current/development/build-instructions.md index 8e2682933..e616e2c08 100644 --- a/i18n/it-IT/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/it-IT/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/it-IT/docusaurus-plugin-content-docs/current/development/development.md b/i18n/it-IT/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/it-IT/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/ja-JP/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/ja-JP/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/ja-JP/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/ja-JP/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/ja-JP/docusaurus-plugin-content-docs/current/development/development.md b/i18n/ja-JP/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/ja-JP/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/ko-KR/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/ko-KR/docusaurus-plugin-content-docs/current/development/build-instructions.md index 566e313a0..d2665bdb3 100644 --- a/i18n/ko-KR/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/ko-KR/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,8 +12,6 @@ _중요한 참고 사항:_: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -필요한 모든 소프트웨어를 설치하는 방법과 각 운영 체제에 맞는 UMS를 구축하는 방법에 대한 자세한 설명은 [전체 지침](#전체 지침) 섹션을 읽어보세요. - # 짧은 지침 모든 필수 소프트웨어 패키지가 설치되면 다음 명령어가 최신 소스를 다운로드하고 UMS를 구축합니다: diff --git a/i18n/ko-KR/docusaurus-plugin-content-docs/current/development/development.md b/i18n/ko-KR/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/ko-KR/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/nl-NL/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/nl-NL/docusaurus-plugin-content-docs/current/development/build-instructions.md index 9e691fb0d..931662af6 100644 --- a/i18n/nl-NL/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/nl-NL/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ De volgende softwarepakketten zijn vereist: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Lees de [Volledige instructies] (#full-instructions) sectie voor een volledige uitleg over hoe je -alle benodigde software installeert en hoe je UMS voor elk besturingssysteem kunt bouwen. - # Korte instructies Als alle benodigde softwarepakketten zijn geïnstalleerd, zullen de volgende commando's diff --git a/i18n/nl-NL/docusaurus-plugin-content-docs/current/development/development.md b/i18n/nl-NL/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..60a936197 --- /dev/null +++ b/i18n/nl-NL/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Ontwikkeling + +Dit document legt uit hoe u uw eigen wijzigingen kan maken en uitvoeren. + +## Forking de code naar je machine + +GitHub maakt het heel eenvoudig voor ontwikkelaars om hun eigen versie van de officiële UMS-bronnen te forken om hun eigen aanpassingen of functies toe te voegen. GitHub vergemakkelijkt het indienen van deze functies als "Pull Requests" aan het officiële UMS ontwikkelteam. + +- [Uw machine instellen voor GitHub ontwikkeling](https://support.github.com/) + +- Ga naar [de GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) en druk op de `Fork` knop rechtsboven. + +- Kloon de nieuwe GitHub repo naar je lokale machine. De URL van de kloon kan gezien worden + op de hoofdpagina van uw opslagplaats. Het zou zoiets moeten zijn als dit + (vervang YOURNAME met je echte GitHub naam): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +Je hebt nu de nieuwe repository op je lokale machine. + +## Ontwikkeling met IDEs + +### [VS Code](https://code.visualstudio.com/) + +Dit is onze aanbevolen editor omdat het geweldig is in het verwerken van zowel Java als TypeScript, onze twee hoofdtalen. + +#### Java server + +Wanneer je de code hebt geopend, zie je waarschijnlijk enkele aanbevelingen voor Extensies om te installeren, zoals het `Extensie Pack voor Java`. Installeer deze/ze. +Wanneer dat is geïnstalleerd en geconfigureerd, kunt u de Java server uitvoeren door op de top `Run -> Start Debugging` te klikken, en herlaad het met `Run -> Herstart Debugging`. Deze commando's moeten binnen 1 seconde voltooid zijn, voor een snelle ontwikkeling workflow. + +#### Webbrowser interfaces + +Als u wijzigingen wilt aanbrengen in onze webbrowserinterfaces, moet u ook de React server runnen. welke zal zorgen voor het compileren en bedienen van de TypeScript code. + +In VS Code kun je naar de `Command Palette` gaan en filteren op `Debug: Selecteer en Start Debugging` en selecteer `Start web interface`. Het zal alle wijzigingen die u aanbrengt in de React bestanden automatisch herladen. + +Voor een handmatige workflow, kunt u naar de `react-client` map gaan en `yarn` starten om de benodigde afhankelijkheden te downloaden. Voer dan `yarn dev` uit die de webspeler in de browser moet openen en automatisch codewijzigingen moet compileren. + +Voor de webinstellingen interface kunt u `react-client/package.json` openen en de proxypoort veranderen van `9002` naar `9001`. Nu `yarn dev` moet de webinstellingen gebruiken in plaats van de webspeler. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Installeer de m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Installeer de EGit Eclipse plugin (http://eclipse.org/egit/) + +- Selecteer in het Eclipse menu "Venster > Weergeven > Git Repositories". Selecteer dan + "Venster > Navigatie > Toon Menu" en kies "Voeg een Repository toe". + Blader naar de map waar u uw repository heeft gekloond en druk op de + "Zoeken". Selecteer uw geforkte repository en druk op "OK". + De repository moet in het overzicht van de Git Repositories verschijnen. + +- Druk op de rechtermuisknop in de repository en selecteer "Importeer Maven + Projecten" in het menu. Selecteer het project "/pom.xml" en druk op "Voltooien". + + Opmerking: als een project met dezelfde naam al bestaat Klik op "Geavanceerd" en + zet het "Naam sjabloon" op "[artifactId]- JOUW NAAM" (vervang JOUW met + je GitHub naam). Druk vervolgens op "Voltooien". + +Je ziet nu de bronnen in Eclipse, maar het project mist nog steeds de aard "Git" +. Met andere woorden, het is nog niet gekoppeld aan de lokale repository. Dit betekent +dat u nog geen Git acties van Eclipse kunt uitvoeren. Voeg de ontbrekende verbinding +toe door het project te delen: + +- Druk op de rechtermuisknop op het nieuw aangemaakte project en selecteer het + menu "Team > Deel Project...". Selecteer "Git" en druk op "Next >". + Vink het selectievakje "Gebruik of maak repository aan in de bovenliggende map van project" + en zorg ervoor dat het project is geselecteerd. Druk vervolgens op "Voltooien". + +Controleer of uw project nu onder Git controle is. Druk op de rechtermuisknop +op het project en onder "Team" zie je nu alle opties om te werken met +Git. + +U kunt UMS bouwen vanuit Eclipse: + +- Maak een nieuwe run configuratie onder "Run > Configuraties uitvoeren...", rechter + muisknop op "Maven Build", selecteer "Nieuw", Naam: `Build UMS`, Goals: + `package`. Selecteer het tabblad "JRE" en voeg de volgende VM argumenten toe + `-Xmx1500m -XX:MaxPermSize=256m`. Druk tenslotte op de knop "Toepassen". + +Je wilt UMS uitvoeren vanaf Eclipse tijdens de ontwikkeling. Zo doe je het: + +- Maak een nieuwe run configuratie onder "Run > Configuratie Uitvoeren... , rechter + muisknop op "Maven Build", selecteer "Nieuw", Naam: `Run UMS`, Basis + directory: `${project_loc}`, Bestemming: "test", Profiles: `run-from-eclipse`. + Selecteer het tabblad "JRE" en voeg VM-argumenten "-Xmx1500m -XX:MaxPermSize=256m" toe. + Druk tenslotte op de knop "Toepassen". + +Je bent nu klaar om te beginnen met ontwikkelen! + +Wanneer je tevreden bent met je wijzigingen, kun je deze toewijzen aan je lokale +repository van Eclipse met behulp van de rechtermuisknop, "Team > Commit...". + +Wanneer je tevreden bent met je verwijzingen en deze wilt publiceren naar je +repository op GitHub, dan kan je op de rechter muisknop drukken op het project en +selecteer "Team > Push naar Upstream". + +## Geef uw wijziging terug door aan ons + +Als je wilt bijdragen aan het UMS-project, kun je een "Pull request" naar het ontwikkelingsteam sturen. Zie [Een pull-aanvraag maken](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) voor meer details. \ No newline at end of file diff --git a/i18n/no-NO/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/no-NO/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/no-NO/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/no-NO/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/no-NO/docusaurus-plugin-content-docs/current/development/development.md b/i18n/no-NO/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/no-NO/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/pl-PL/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/pl-PL/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/pl-PL/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/pl-PL/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/pl-PL/docusaurus-plugin-content-docs/current/development/development.md b/i18n/pl-PL/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/pl-PL/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/pt-BR/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/pt-BR/docusaurus-plugin-content-docs/current/development/build-instructions.md index 2a6616dac..9352e658f 100644 --- a/i18n/pt-BR/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/pt-BR/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ Os seguintes pacotes de software são necessários: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/pt-BR/docusaurus-plugin-content-docs/current/development/development.md b/i18n/pt-BR/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/pt-BR/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/pt-PT/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/pt-PT/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/pt-PT/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/pt-PT/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/pt-PT/docusaurus-plugin-content-docs/current/development/development.md b/i18n/pt-PT/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/pt-PT/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/ro-RO/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/ro-RO/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/ro-RO/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/ro-RO/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/ro-RO/docusaurus-plugin-content-docs/current/development/development.md b/i18n/ro-RO/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/ro-RO/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/ru-RU/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/ru-RU/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/ru-RU/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/ru-RU/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/ru-RU/docusaurus-plugin-content-docs/current/development/development.md b/i18n/ru-RU/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/ru-RU/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/sk-SK/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/sk-SK/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/sk-SK/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/sk-SK/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/sk-SK/docusaurus-plugin-content-docs/current/development/development.md b/i18n/sk-SK/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/sk-SK/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/sl-SI/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/sl-SI/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/sl-SI/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/sl-SI/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/sl-SI/docusaurus-plugin-content-docs/current/development/development.md b/i18n/sl-SI/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/sl-SI/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/sr-SP/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/sr-SP/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/sr-SP/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/sr-SP/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/sr-SP/docusaurus-plugin-content-docs/current/development/development.md b/i18n/sr-SP/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/sr-SP/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/sv-SE/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/sv-SE/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/sv-SE/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/sv-SE/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/sv-SE/docusaurus-plugin-content-docs/current/development/development.md b/i18n/sv-SE/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/sv-SE/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/tr-TR/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/tr-TR/docusaurus-plugin-content-docs/current/development/build-instructions.md index ec17f381e..bd02fae65 100644 --- a/i18n/tr-TR/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/tr-TR/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,8 +12,6 @@ Aşağıdaki yazılım paketleri gerekir: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Gerekli tüm yazılımların nasıl yükleneceğini ve her işletim sistemi için UMS’nin nasıl oluşturulacağına ilişkin tam bir açıklama için [Tam talimatlar](#full-instructions) bölümünü okuyun. - # Kısa talimatlar Eğer gerekli tüm yazılım paketleri yüklüyse aşağıdaki komutlar en son kaynakları indirecek ve UMS’yi oluşturacaktır: diff --git a/i18n/tr-TR/docusaurus-plugin-content-docs/current/development/development.md b/i18n/tr-TR/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..800ff0863 --- /dev/null +++ b/i18n/tr-TR/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,99 @@ +# Geliştirme + +Bu belge kendi değişikliklerinizi nasıl yapacağınızı ve çalıştıracağınızı açıklar. + +## Kodu makinenize çatallamayla ikiye ayırma + +GitHub, geliştiricilerin kendi ince ayarlarını veya özelliklerini eklemek için resmi UMS kaynaklarının kendi sürümlerini çatallamalarını çok kolaylaştırır. GitHub, bu özelliklerin resmi UMS geliştirme ekibine "Çekme İstekleri" olarak gönderilmesini kolaylaştırır. + +- [GitHub geliştirme için makinenizi ayarlayın](https://support.github.com/) + +- [GitHub UMS deposuna](https://github.com/universalmediaserver/universalmediaserver) gidin ve sağ üstteki `Fork` düğmesine basın. + +- Yeni GitHub deposunu yerel makinenize çoğaltın. Çoğaltma URL’si deponuzun ana sayfasında görülebilir. Bu, şunun gibi bir şey olmalı (ADINIZI asıl GitHub adınızla değiştirin): + + git clone git@github.com:ADINIZ/universalmediaserver.git ADINIZ + +Artık yerel makinenizde yeni deponuz var. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/tr-TR/docusaurus-plugin-content-docs/current/guides/how-to-add-web-content.md b/i18n/tr-TR/docusaurus-plugin-content-docs/current/guides/how-to-add-web-content.md index f00d7a1b3..4f24300c2 100644 --- a/i18n/tr-TR/docusaurus-plugin-content-docs/current/guides/how-to-add-web-content.md +++ b/i18n/tr-TR/docusaurus-plugin-content-docs/current/guides/how-to-add-web-content.md @@ -34,7 +34,7 @@ Bu görüntü yayınının bağlantısıdır. Genellikle ".xml" ile biter, ancak #### Yetkili gruplar -"Yetkili gruplar" alanı, bu yayını yalnızca UMS’de tanımlanmış ve farklı kullanıcılar ve/veya cihazlarla ilişkilendirilmiş belirli gruplar tarafından kullanılabilir olmasını sağlar. Daha fazla ayrıntı için [Güvenlik ve Gizlilik](../configuration/security-and-privacy.md#link-person-to-renderer) konusuna bakın. +"Yetkili gruplar" alanı, bu yayını yalnızca UMS’de tanımlanmış ve farklı kullanıcılar ve/veya cihazlarla ilişkilendirilmiş belirli gruplar tarafından kullanılabilir olmasını sağlar. Daha fazla ayrıntı için [Güvenlik ve Gizlilik](../configuration/security-and-privacy.md#kişiyi-işleyiciye-bağlantılayın) konusuna bakın. Girdiğiniz seçeneklerden memnun olduğunuzda "Ekle" düğmesine tıklayın. diff --git a/i18n/uk-UA/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/uk-UA/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/uk-UA/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/uk-UA/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/uk-UA/docusaurus-plugin-content-docs/current/development/development.md b/i18n/uk-UA/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/uk-UA/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/vi-VN/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/vi-VN/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/vi-VN/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/vi-VN/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/vi-VN/docusaurus-plugin-content-docs/current/development/development.md b/i18n/vi-VN/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/vi-VN/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/configuration/security-and-privacy.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/configuration/security-and-privacy.md index 1b4b3e941..a7956717c 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/configuration/security-and-privacy.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/configuration/security-and-privacy.md @@ -8,20 +8,20 @@ UMS主要通过两种方式提供媒体服务——通过DLNA/UPnP供媒体播 媒体播放器应用通常不支持“用户”概念，因此，一般而言每台设备都会获取相同的内容。 这可能不是你想要的。 例如，如果你有两个文件夹 kids_safe 和 kids_unsafe，你可能想要限制儿童房中的渲染器，使其只能访问 kids_safe 文件夹。 另一种常见情况是，你和不想让其访问你媒体的人（例如室友）处于同一网络，因此你想要完全屏蔽某些渲染器。 -UMS provides a number of methods to control access in those situations. +UMS 提供了多种方法来控制这些情况下的访问。 -## Allow or block renderers or network devices by default -You can choose the default strategy for renderers and network devices. You can allow or deny by default, with denylists and allowlists, for complete control. +## 默认允许或阻止渲染器或网络设备 +你可以为渲染器和网络设备选择默认策略。 你可以默认允许或拒绝，配合黑名单和白名单，实现完全控制。 -This is useful for shared living situations or wide/low-trust local networks. It is also useful for those of you using powerline adapters for your network since that can result in unwanted access from neighbors. +这对于合住环境或广泛/低信任度的本地网络非常有用。 对于使用电力线适配器搭建网络的用户也很有用，因为这可能导致来自邻居的意外访问。 -![Example of how to set network allow preference](@site/docs/img/whats-new-in-v14-network-allowblock-preference.png) +![设置网络允许偏好的示例](@site/docs/img/whats-new-in-v14-network-allowblock-preference.png) -![Example of how to set renderer allow preference](@site/docs/img/whats-new-in-v14-renderer-allow-preference.png) +![设置渲染器允许偏好的示例](@site/docs/img/whats-new-in-v14-renderer-allow-preference.png) -## Block/allow renderers and network devices +## 阻止/允许渲染器和网络设备 -When you have chosen whether to allow or block unrecognized renderers by default, you can build your denylist or allowlist from the Home screen in the settings area. +当你选定了默认允许还是阻止未识别的渲染器后，就可以在设置区域的主屏幕上构建黑名单或白名单。 ![Example of how to block a renderer](@site/docs/img/whats-new-in-v14-block-renderer.png) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/development.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/development/build-instructions.md b/i18n/zh-TW/docusaurus-plugin-content-docs/current/development/build-instructions.md index 06750a823..3560deab0 100644 --- a/i18n/zh-TW/docusaurus-plugin-content-docs/current/development/build-instructions.md +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/development/build-instructions.md @@ -12,9 +12,6 @@ The following software packages are required: - Maven - [MediaInfo](https://mediaarea.net/en/MediaInfo/Download) -Read the [Full instructions](#full-instructions) section for a complete explanation of how to -install all required software and how to build UMS for each operating system. - # Short instructions If all required software packages are installed, the following commands will diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/development/development.md b/i18n/zh-TW/docusaurus-plugin-content-docs/current/development/development.md new file mode 100644 index 000000000..d4bb8692e --- /dev/null +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/development/development.md @@ -0,0 +1,101 @@ +# Development + +This document explains how to make and run your own changes. + +## Forking the code to your machine + +GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team. + +- [Set up your machine for GitHub development](https://support.github.com/) + +- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right. + +- Clone the new GitHub repo to your local machine. The clone URL can be seen + on the main page of your repository. It should be something like this + (replace YOURNAME with your actual GitHub name): + + git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME + +You now have the new repository on your local machine. + +## Development with IDEs + +### [VS Code](https://code.visualstudio.com/) + +This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages. + +#### Java server + +When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them. +When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow. + +#### Web browser interfaces + +If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code. + +In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files. + +For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make. + +For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player. + +### [Eclipse](http://www.eclipse.org/downloads/) + +- Install the m2e Eclipse plugin (http://eclipse.org/m2e/) + +- Install the EGit Eclipse plugin (http://eclipse.org/egit/) + +- In Eclipse, select the menu "Window > Show View > Git Repositories". Then + select "Window > Navigation > Show View Menu", choose "Add a Repository". + Browse for the directory where you cloned your repository and press the + "Search" button. Select your forked repository and press "OK". + The repository should appear in the Git Repositories view. + +- Press the right mouse button on the repository and select "Import Maven + Projects" from the menu. Select the project "/pom.xml" and press "Finish". + + Note: if a project with the same name already exists, click "Advanced" and + set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with + your GitHub name). Then press "Finish". + +You now see the sources in Eclipse, but the project is still missing the "Git" +nature. In other words, it is not tied to the local repository yet. This means +you cannot perform any Git actions from Eclipse yet. Add the missing connection +by sharing the project: + +- Press the right mouse button on the newly created project and select the + menu "Team > Share Project...". Select "Git" and press "Next >". + Check the checkbox "Use or create repository in parent folder of project" + and make sure the project is selected. Then press "Finish". + +Verify that your project is now under Git control. Press the right mouse +button on the project and under "Team" you now see all options to work with +Git. + +You can build UMS from Eclipse: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals: + `package`. Select the tab "JRE" and add the following VM arguments + `-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button. + +You will want to run UMS from Eclipse while developing. This is how you do it: + +- Create a new run configuration under "Run > Run Configurations...", right + mouse button on "Maven Build", select "New", Name: `Run UMS`, Base + directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`. + Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`. + Finally, press the "Apply" button. + +You are now ready to start developing! + +When you are happy with your changes, you can commit them to your local +repository from Eclipse using right mouse button, "Team > Commit...". + +When you are satisfied with your commits and want to publish them to your +repository at GitHub, you can press the right mouse button on the project and +select "Team > Push to Upstream". + +## Contributing your change back to us + +If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details. \ No newline at end of file