You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README-sdk-dev.md
+26-19Lines changed: 26 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,6 @@ It is intended for BB2 team members or others performing SDK development work.
12
12
13
13
npm recommends install node using nvm (node version manager), for install instruction, check out: https://github.com/nvm-sh/nvm
14
14
15
-
16
15
```
17
16
check nvm version:
18
17
nvm -v
@@ -102,6 +101,7 @@ cd my_proj
102
101
yarn init
103
102
...
104
103
```
104
+
105
105
Setting npm config global settings will make subsequently created pacakge projects 'private'.
106
106
107
107
Note that publishing package 'private' is a npm option that requires payment.
@@ -110,31 +110,38 @@ Note that publishing package 'private' is a npm option that requires payment.
110
110
111
111
1. Consuming from npm registry:
112
112
113
-
```
114
-
mkdir my_proj
115
-
cd my_proj
116
-
yarn init
117
-
yarn add cms-bluebutton-sdk
113
+
```
114
+
mkdir my_proj
115
+
cd my_proj
116
+
yarn init
117
+
yarn add cms-bluebutton-sdk
118
118
119
-
continue adding other dependencies, e.g. express, ts-node, etc., ...
119
+
continue adding other dependencies, e.g. express, ts-node, etc., ...
120
120
121
-
yarn add express @types/express ts-node
122
-
yarn add <other dependencies>
123
-
```
121
+
yarn add express @types/express ts-node
122
+
yarn add <other dependencies>
123
+
```
124
124
125
125
2. Consuming from a local SDK repository (as a good test before publishing):
126
126
127
-
After built and generated typescript types (needed if to be consumed by typescript project), the sdk can be consumed by other projects as shown by below example:
127
+
After built and generated typescript types (needed if to be consumed by typescript project), the sdk can be consumed by other projects as shown by below example:
128
128
129
-
```
130
-
mkdir my_proj
131
-
cd my_proj
132
-
yarn init
133
-
yarn add <path to local cms-bluebutton-sdk local repository base directory>
129
+
```
130
+
mkdir my_proj
131
+
cd my_proj
132
+
yarn init
133
+
yarn add <path to local cms-bluebutton-sdk local repository base directory>
134
+
135
+
continue adding other dependencies, e.g. express, ts-node, etc., ...
134
136
135
-
continue adding other dependencies, e.g. express, ts-node, etc., ...
137
+
yarn add express @types/express ts-node
138
+
yarn add <other dependencies>
139
+
```
136
140
137
-
yarn add express @types/express ts-node
138
-
yarn add <other dependencies>
141
+
# It is known that there are traces of yarn being used in this repo, however Snyk currently blocks the merge of yarn 1.22.22 despite it being the latest version due to the fact that there is a security vulnerability. The steps listed here can still be followed after running:
142
+
143
+
```
144
+
npm install yarn
139
145
```
140
146
147
+
# In the future, we would like to move to using only a single package manager.
0 commit comments