https://github.com/gopad/gopad-js
Javascript SDK for Gopad
https://github.com/gopad/gopad-js
etherpad gopad javascript openapi sdk
Last synced: 25 days ago
JSON representation
Javascript SDK for Gopad
- Host: GitHub
- URL: https://github.com/gopad/gopad-js
- Owner: gopad
- License: apache-2.0
- Created: 2018-04-05T23:18:30.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2026-02-11T01:46:53.000Z (about 2 months ago)
- Last Synced: 2026-02-11T06:04:49.734Z (about 2 months ago)
- Topics: etherpad, gopad, javascript, openapi, sdk
- Language: TypeScript
- Homepage: https://gopad.eu
- Size: 26.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Dco: DCO
Awesome Lists containing this project
README
# Gopad: SDK for Javascript
[](https://github.com/gopad/gopad-js/actions/workflows/general.yml) [](https://matrix.to/#/#gopad:matrix.org) [](https://app.codacy.com/gh/gopad/gopad-js/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [](https://badge.fury.io/js/gopadjs)
This repository provides a client SDK for Typescript/Javascript. This SDK is
automatically generated by the [OpenAPI Generator][generator] project:
- API version: 1.0.0-alpha1
- Package version: 3.4.0
- Build package: org.openapitools.codegen.languages.TypeScriptAxiosClientCodegen
For more information, please visit [https://gopad.eu](https://gopad.eu)
## Environments
- Node.js
- Webpack
- Browserify
## Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
## Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition
will be automatically resolved via `package.json`.
## Installation
### Installation with NPM
If you want to use one of the versions released via NPM you just need to execute
the following command within your project directory, after that you can import
it as other libraries:
```console
npm install --save gopadjs@3.4.0
```
### Installation with Git
If you want to use an unreleased version hosted on our GitHub repository you can
execute the folling command within your project directory, after that you can
import it as other libraries:
```console
npm install --save https://github.com/gopad/gopad-js
```
## Building
To build and compile the Typescript sources to Javascript simply execute the
following commands and you are ready to go:
```console
npm install
npm run build
```
## Security
If you find a security issue please contact
[gopad@webhippie.de](mailto:gopad@webhippie.de) first.
## Contributing
Fork -> Patch -> Push -> Pull Request
## Authors
- [Thomas Boerger](https://github.com/tboerger)
## License
Apache-2.0
## Copyright
```console
Copyright (c) 2018 Thomas Boerger
```
[generator]: https://openapi-generator.tech