@deepdesk/deepdesk-sdk 10.1.0 → 10.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -59
- package/dist/index.cjs.js +5 -5
- package/dist/index.d.mts +200 -198
- package/dist/index.d.ts +200 -198
- package/dist/index.esm.js +5 -5
- package/dist/index.iife.js +29 -29
- package/package.json +4 -3
- package/styles/index.js +1 -1
- package/styles.css +1 -1
package/README.md
CHANGED
|
@@ -1,60 +1,3 @@
|
|
|
1
|
-
#
|
|
1
|
+
# DeepdeskSDK
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
### Prerequisites
|
|
6
|
-
|
|
7
|
-
- [Node.js](https://nodejs.org/en/download/) v16
|
|
8
|
-
- Npm v8
|
|
9
|
-
|
|
10
|
-
### Setup
|
|
11
|
-
|
|
12
|
-
Copy-paste `example.env` to `.env` and provide values for missing environment vars.
|
|
13
|
-
|
|
14
|
-
```bash
|
|
15
|
-
cp example.env .env
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
Install Node.js dependencies
|
|
19
|
-
|
|
20
|
-
```bash
|
|
21
|
-
npm ci
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
### Development
|
|
25
|
-
|
|
26
|
-
Run tests
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
npm run test
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Run code linting
|
|
33
|
-
|
|
34
|
-
```bash
|
|
35
|
-
npm run lint
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
Run playground to test and develop the DeepdeskSDK
|
|
39
|
-
|
|
40
|
-
```bash
|
|
41
|
-
npm run dev
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### Cross project development
|
|
45
|
-
|
|
46
|
-
If you want to test/debug/develop the DeepdeskSDK in another project. You could link this package in the other project.
|
|
47
|
-
|
|
48
|
-
First make the DeepdeskSDK available on you local machine. And start it in linked development mode:
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
npm run link
|
|
52
|
-
npm run dev-linked
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
Then link the DeepdeskSDK to the project you are working on. Depending on the dev-watch setup, changes made in the DeepdeskSDK are reflected in the other project.
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
# other project (eg. deepdesk-chrome-extension)
|
|
59
|
-
npm link @deepdesk/deepdesk-sdk
|
|
60
|
-
```
|
|
3
|
+
[Documentation](https://deepdesk.github.io)
|