3cx_tapi/readme.md

54 lines
1.7 KiB
Markdown
Raw Normal View History

2020-11-04 22:59:32 +01:00
# 3CX TAPI
Inject CPA TAPI functions into the 3CX Webclient
## dev
1. Allow Tampermonkey's access to local file URIs [tampermonkey/faq](https://tampermonkey.net/faq.php?ext=dhdg#Q204)
2. install deps with `npm i` or `npm ci`.
3. `npm run dev` to start your development.
4. open `webpack-userscript-template/dist/index.dev.user.js` in your Chrome and install it with your userscript manager.
this userscript's meta contains `// @require file://path/to/dist/index.prod.user.js`,
it will run the code in `index.prod.user.js`,
which take [src/js/index.js](./src/js/index.js) as entry point.
every times you edit your metadata, you'll have to install it again,
because Tampermonkey don't read it from dist every times.
5. edit [src/js/index.js](./src/js/index.js) with es6, you can even import css or less files. You can use scss if you like.
livereload is default enabled, use [this chrome extension](https://chrome.google.com/webstore/detail/jnihajbhpnppcggbcgedagnkighmdlei)
## dependencies
There are two ways to using a package on npm.
### UserScript way
Like original UserScript way, you will need to add them to your [user script metadata's require section](./config/metadata.js#L13-L17) , and exclude them in [config/webpack.config.base.js](./config/webpack.config.base.js#L21-L25)
### Webpack way
just install a package and import it in your js file. webpack will pack them with in your final production js file.
## build
```
npm run build
```
`dist/index.prod.user.js` is the final script.
## distribution
```
2021-08-27 18:14:41 +02:00
cp "dist/3CX TAPI.prod.user.js" 3CX_TAPI.user.js
2020-11-04 22:59:32 +01:00
```
And commit 3CX_TAPI.user.js
## see also
2020-11-04 23:36:32 +01:00
Based on [webpack-userscript-template](https://github.com/Trim21/webpack-userscript-template/)