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
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).
264
-
265
-
[](#demos-and-development)
266
-
267
-
## Demos and Development
268
-
269
-
270
-
### Repo Setup
271
-
272
-
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
273
-
```
274
-
git submodule update --init
275
-
```
276
-
277
-
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
278
-
279
-
To develop and test:
280
-
if you use `yarn` then run `yarn`
281
-
if you use `pnpm` then run `pnpm i`
282
-
283
-
**Interactive Menu:**
284
-
285
-
To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
286
-
287
-
### Build
288
-
289
-
```bash
290
-
npm run build.all
291
-
```
292
-
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
293
-
294
-
### Demos
295
-
296
-
```bash
297
-
npm run demo.[ng|react|svelte|vue].[ios|android]
298
-
299
-
npm run demo.svelte.ios # Example
300
-
```
301
-
302
-
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
303
-
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
304
-
You can start from the `install.ts` of each flavor to see how to register new demos
305
-
306
-
307
-
[](#contributing)
308
-
309
-
## Contributing
310
-
311
-
### Update repo
312
-
313
-
You can update the repo files quite easily
314
-
315
-
First update the submodules
316
-
317
-
```bash
318
-
npm run update
319
-
```
320
-
321
-
Then commit the changes
322
-
Then update common files
323
-
324
-
```bash
325
-
npm run sync
326
-
```
327
-
Then you can run `yarn|pnpm`, commit changed files if any
328
-
329
-
### Update readme
330
-
```bash
331
-
npm run readme
332
-
```
333
-
334
-
### Update doc
335
-
```bash
336
-
npm run doc
337
-
```
338
-
339
-
### Publish
340
-
341
-
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
342
-
Simply run
343
-
```shell
344
-
npm run publish
345
-
```
346
-
347
-
### modifying submodules
348
-
349
-
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
350
-
One easy solution is t modify `~/.gitconfig` and add
<pre><codeclass="language-bash"><spanclass="hl-1">npm run build.all</span>
167
166
</code></pre>
168
-
<p>WARNING: it seems <code>yarn build.all</code> wont always work (not finding binaries in <code>node_modules/.bin</code>) which is why the doc explicitly uses <code>npm run</code></p>
<pre><codeclass="language-bash"><spanclass="hl-1">npm run demo.[ng|react|svelte|vue].[ios|android]</span><br/><br/><spanclass="hl-1">npm run demo.svelte.ios </span><spanclass="hl-9"># Example</span>
174
172
</code></pre>
175
-
<p>Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in <code>demo-[ng|react|svelte|vue]</code>
176
-
Instead you work in <code>demo-snippets/[ng|react|svelte|vue]</code>
177
-
You can start from the <code>install.ts</code> of each flavor to see how to register new demos </p>
178
173
<p><ahref="#contributing"></a></p>
179
174
<p><ahref="#contributing"></a></p>
180
175
@@ -214,107 +209,13 @@ <h3>Publish</h3>
214
209
Simply run </p>
215
210
<pre><codeclass="language-shell"><spanclass="hl-1">npm run publish</span>
<p>If you have any questions/issues/comments please feel free to create an issue or start a conversation in the <ahref="https://nativescript.org/discord">NativeScript Community Discord</a>.</p>
<p>The package manager used to install and link dependencies must be <code>pnpm</code> or <code>yarn</code>. <code>npm</code> wont work.</p>
245
-
<p>To develop and test:
246
-
if you use <code>yarn</code> then run <code>yarn</code>
247
-
if you use <code>pnpm</code> then run <code>pnpm i</code></p>
248
-
<p><strong>Interactive Menu:</strong></p>
249
-
<p>To start the interactive menu, run <code>npm start</code> (or <code>yarn start</code> or <code>pnpm start</code>). This will list all of the commonly used scripts.</p>
<pre><codeclass="language-bash"><spanclass="hl-1">npm run build.all</span>
255
-
</code></pre>
256
-
<p>WARNING: it seems <code>yarn build.all</code> wont always work (not finding binaries in <code>node_modules/.bin</code>) which is why the doc explicitly uses <code>npm run</code></p>
<pre><codeclass="language-bash"><spanclass="hl-1">npm run demo.[ng|react|svelte|vue].[ios|android]</span><br/><br/><spanclass="hl-1">npm run demo.svelte.ios </span><spanclass="hl-9"># Example</span>
262
-
</code></pre>
263
-
<p>Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in <code>demo-[ng|react|svelte|vue]</code>
264
-
Instead you work in <code>demo-snippets/[ng|react|svelte|vue]</code>
265
-
You can start from the <code>install.ts</code> of each flavor to see how to register new demos </p>
<p>If you have any questions/issues/comments please feel free to create an issue or start a conversation in the <ahref="https://nativescript.org/discord">NativeScript Community Discord</a>.</p>
0 commit comments