pad.libre-service.eu-etherpad/bin/plugins/lib/README.md
JannikStreek 04063d664b
cleanup after workspace refactoring (#6174)
* fix bin folder and workflows as far its possible

cleanup of dockerfile

changed paths of scripts

add lock file

fix working directory for workflows

fix windows bin

fix travis (is travis used anyway?)

fix package refs

remove pnpm-lock file in root as these conflicts with the docker volume setup

optimize comments

use install again

refactor prod image call to run

fix --workspace can only be used inside a workspace

correct comment

try fix pipeline

try fix pipeline for upgrade-from-latest-release

install all deps

smaller adjustments

save

update dockerfile

remove workspace command

fix run test command

start repair latest release workflow

start repair latest release workflow

start repair latest release workflow

further repairs

* remove test plugin from docker compose
2024-02-21 21:50:11 +01:00

47 lines
1.2 KiB
Markdown
Executable file

# [plugin_name]
TODO: Describe the plugin.
## Example animated gif of usage if appropriate
![screenshot](https://user-images.githubusercontent.com/220864/99979953-97841d80-2d9f-11eb-9782-5f65817c58f4.PNG)
## Installation
From the Etherpad working directory, run:
```shell
npm install --no-save --legacy-peer-deps [plugin_name]
```
Or, install from Etherpad's `/admin/plugins` page.
## Configuration
TODO
## Testing
To run the backend tests, run the following from the Etherpad working directory:
```shell
(cd src && pnpm test)
```
To run the frontend tests, visit: http://localhost:9001/tests/frontend/
## Copyright and License
Copyright © [yyyy] [name of copyright owner]
and the [plugin_name] authors and contributors
Licensed under the [Apache License, Version 2.0](LICENSE) (the "License"); you
may not use this file except in compliance with the License. You may obtain a
copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.