Quitter le mode Zen
21
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Bullet: '* '
`nodejs` (>=14.x)
0/170 · 17
22
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Bullet: '* '
`build-essential`
0/170 · 17
25
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Bullet: '* '
`reuse`
0/100 · 7
26
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
Please note that this plugin needs an AppImage for the Prosody XMPP server. This AppImage is provided by the [Prosody AppImage](https://github.com/JohnXLivingston/prosody-appimage) sideproject. The `build-prosody.sh` script download binaries attached to this remote repository, and checks that their sha256 hashsum are correct.
0/3290 · 329
web
Anglais
Web
0/100 · 3
27
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
Clone the repository, buid the plugin, and create your feature branch:
0/700 · 70
connect_using_xmpp
Anglais
Connect using XMPP
0/180 · 18
28
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Fenced code block (bash)
# Clone the repository. Dont forget the --recursive to clone submodules.
git clone https://github.com/JohnXLivingston/peertube-plugin-livechat.git --recursive

cd peertube-plugin-livechat

# Install NPM dependencies and build the module for the first time:
npm install

# Build the plugin after a modification:
npm run build

# If you have a fork from the repository, add it as remote (example):
git remote add me git@github.com:MY_GITHUB_ACCOUNT/peertube-plugin-livechat.git

# Create a local branch for you developments, and checkout it (example):
git checkout my_development # Note: if an issue is associated, use fix_1234 as your branch name (where 1234 is the issue's number)
# To propose your modifications, push your branch to your repository (example):
git push --set-upstream me my_development
# Then go to your github repository with your web browser to propose the Pull Request (see additional instructions below)
0/9250 · 925
connect_using_xmpp_help
Anglais
You can connect to the room using an external XMPP account, and your favorite XMPP client.
0/900 · 90
29
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
Once you are ready to show your code to ask for feedback, submit a *draft* Pull Request. Once you are ready for a code review before merge, submit a Pull Request. In any case, please link your PR to the issues it solves by using the GitHub syntax: "fixes #issue_number".
0/2720 · 272
30
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
The front-end code is in the `client` folder, the back-end code in `server`. There are some shared code in `shared` folder.
0/1230 · 123
31
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
For general instructions (developping plugins, building, installation, ...), please refer to the [Peertube documentation](https://docs.joinpeertube.org/contribute-plugins?id=write-a-plugintheme).
0/1950 · 195
32
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
You can build the plugin with extra debug features simply by using:
0/670 · 67
34
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
This plugin is [REUSE](https://reuse.software/) compliant: it uses SPDX headers to identify licensing information of its source code. More information on the [REUSE](https://reuse.software/) website. You can use the [reuse](https://reuse.readthedocs.io/en/stable/readme.html#) command line tool to help you update headers. The `npm run lint` command will use the `reuse` command to check compliance. Don't forget to add your copyright information in SPDX headers when you modify some code.
0/4930 · 493
35
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Title ##
ESBuild vs Typescript
0/210 · 21
36
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
This plugin uses ESBuild for frontend code generation, as the official `peertube-plugin-quickstart` plugin. ESBuild can handle Typescript, but does not check types (see [ESBuild documentation](https://esbuild.github.io/content-types/#typescript)). That's why we first compile Typescript with the `-noEmit` option, just to check types (`check:client:ts` in package.json file). Then, if everything is okay, we run ESBuild to generate the compiled javascript.
0/4590 · 459
37
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Title ##
Debug Mode
0/100 · 10
38
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
There is a debug mode for this plugin, that shorten some delay. For example, some log files will rotate every two minutes, instead of once per day. This permit to test more easily certain actions, for which it could normally take hours or days to wait.
0/2540 · 254
39
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
To enable this mode, you juste have to create the `/var/www/peertube/storage/plugins/data/peertube-plugin-livechat/debug_mode` file (replacing `/var/www/peertube/storage/` by the correct path on your installation).
0/2140 · 214
40
support/documentation/content/en/contributing/develop/_index.md
Anglais type: Plain text
The simple existence of this file is sufficient to trigger the debug mode. To make sure it's taken into account, you can restart your Peertube instance.
0/1530 · 153