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