UNPKG

bimplus-websdk

Version:

bim+ websdk

119 lines (72 loc) • 3.29 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
bim+ websdk ========= bim+ websdk is a javascript wrapper around the bim+ api Quick Links ----------- https://nemetschekprime.atlassian.net/wiki/spaces/bimpluspublic/pages/1090127532/Bimplus+Web+SDK+Reference How to build ------------ ### Install nodejs [http://www.nodejs.org/](http://www.nodejs.org/) ### Install local npm modules Open up a normal command line (admin is not needed) and go to the websdk folder npm install (whenever package.json has changed, you might to do this again) ### Build websdk Library building process is using UMD (Universal Module Definition) output format so it's compatible with both cjs and amd module formats. The same library can be use in the client or on the server. Build process is using babel so it's possible to use new ES2015 code in source codes. Library can be build in several ways as a dev or prod version. To run a dev build with source maps run: npm run build To build a prod version - uglified, minified run: npm run build-prod Pulish new release to npm (Hint: Before doing this npm login needs to be done and the package version adjusted) : npm run npm-publish Check content of npm package (result is bimplus-renderer@(version).tar.gz) npm run npm-pack ### Develop/Debug websdk goto your websdk folder npm link goto your application folder which uses the websdk npm link bimplus-websdk Do you changes in the websdk and build npm run build or npm run build-prod Your app will automatically get the changes done in the renderer After developing it might be wise to unlink: goto your websdk folder npm unlink goto your application folder which uses the websdk npm unlink bimplus-websdk npm install ### Unit testing With every build output is copied also to the test folder. To run the unit tests go to the test subfolder and run : npm install npm run test For more information see README.md inside the test folder ### Documentation Bimplus WebSDK uses npm documentation plugin for easy documentation generation. To generate a documentation please install documentation plugin via npm : npm install -g documentation To create documentation in html format go to your websdk folder and run : npm run build-doc Documentation output will be in websdk/documentation folder To create documentation in markdown format go to your websdk folder and run : npm run build-docMd Documentation output will be in websdk/documentation/Bimplus_WebSDK_doc.md file. To create a markdown suitable for Confluence run script: npm run build-docConf This script will convert generated markdown into Confluence format. See console output for converted file name. Content of the confluence file can be inserted into Confluence page : - start confluence page editation mode - choose Insert more content / {} Markup option from toolbar - in popup window choose to Insert Markdown format - copy content of the converted confluence markdown file into the field in Confluence - save it (Please note that page links doesn't work in page preview mode) ### Typescript definitions - typescript definition file is located in subfolder 'types'