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.md
+98-1Lines changed: 98 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -763,4 +763,101 @@ One easy solution is t modify `~/.gitconfig` and add
763
763
## Questions
764
764
765
765
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).
766
-
</details>
766
+
</details>
767
+
768
+
[](#demos-and-development)
769
+
770
+
## Demos and Development
771
+
772
+
773
+
### Repo Setup
774
+
775
+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
776
+
```
777
+
git submodule update --init
778
+
```
779
+
780
+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
781
+
782
+
To develop and test:
783
+
if you use `yarn` then run `yarn`
784
+
if you use `pnpm` then run `pnpm i`
785
+
786
+
**Interactive Menu:**
787
+
788
+
To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
789
+
790
+
### Build
791
+
792
+
```bash
793
+
npm run build.all
794
+
```
795
+
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`
796
+
797
+
### Demos
798
+
799
+
```bash
800
+
npm run demo.[ng|react|svelte|vue].[ios|android]
801
+
802
+
npm run demo.svelte.ios # Example
803
+
```
804
+
805
+
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]`
806
+
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
807
+
You can start from the `install.ts` of each flavor to see how to register new demos
808
+
809
+
810
+
[](#contributing)
811
+
812
+
## Contributing
813
+
814
+
### Update repo
815
+
816
+
You can update the repo files quite easily
817
+
818
+
First update the submodules
819
+
820
+
```bash
821
+
npm run update
822
+
```
823
+
824
+
Then commit the changes
825
+
Then update common files
826
+
827
+
```bash
828
+
npm run sync
829
+
```
830
+
Then you can run `yarn|pnpm`, commit changed files if any
831
+
832
+
### Update readme
833
+
```bash
834
+
npm run readme
835
+
```
836
+
837
+
### Update doc
838
+
```bash
839
+
npm run doc
840
+
```
841
+
842
+
### Publish
843
+
844
+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
845
+
Simply run
846
+
```shell
847
+
npm run publish
848
+
```
849
+
850
+
### modifying submodules
851
+
852
+
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
853
+
One easy solution is t modify `~/.gitconfig` and add
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).
<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>
660
+
<p>To develop and test:
661
+
if you use <code>yarn</code> then run <code>yarn</code>
662
+
if you use <code>pnpm</code> then run <code>pnpm i</code></p>
663
+
<p><strong>Interactive Menu:</strong></p>
664
+
<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>
670
+
</code></pre>
671
+
<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-6"># Example</span>
677
+
</code></pre>
678
+
<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>
679
+
Instead you work in <code>demo-snippets/[ng|react|svelte|vue]</code>
680
+
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