-
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fca430b
commit bd73adf
Showing
6 changed files
with
82 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -43,9 +43,15 @@ | |
* [Vue](#vue) | ||
* [Examples](#examples) | ||
* [Demos and Development](#demos-and-development) | ||
* [Setup](#setup) | ||
* [Repo Setup](#repo-setup) | ||
* [Build](#build) | ||
* [Demos](#demos) | ||
* [Contributing](#contributing) | ||
* [Update repo ](#update-repo-) | ||
* [Update readme ](#update-readme-) | ||
* [Update doc ](#update-doc-) | ||
* [Publish](#publish) | ||
* [modifying submodules](#modifying-submodules) | ||
* [Questions](#questions) | ||
|
||
|
||
|
@@ -93,18 +99,18 @@ export function openFilePicker(params: FilePickerOptions): Promise<{ files: stri | |
## Demos and Development | ||
|
||
|
||
### Setup | ||
|
||
To run the demos, you must clone this repo **recursively**. | ||
### Repo Setup | ||
|
||
The repo uses submodules. If you did not clone with ` --recursive` then you need to call | ||
``` | ||
git clone https://github.com/@nativescript-community/ui-document-picker.git --recursive | ||
git submodule update --init | ||
``` | ||
|
||
**Install Dependencies:** | ||
```bash | ||
npm i # or 'yarn install' or 'pnpm install' | ||
``` | ||
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work. | ||
|
||
To develop and test: | ||
if you use `yarn` then run `yarn` | ||
if you use `pnpm` then run `pnpm i` | ||
|
||
**Interactive Menu:** | ||
|
||
|
@@ -113,10 +119,9 @@ To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`) | |
### Build | ||
|
||
```bash | ||
npm run build | ||
|
||
npm run build.angular # or for Angular | ||
npm run build.all | ||
``` | ||
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` | ||
|
||
### Demos | ||
|
||
|
@@ -125,6 +130,61 @@ npm run demo.[ng|react|svelte|vue].[ios|android] | |
|
||
npm run demo.svelte.ios # Example | ||
``` | ||
|
||
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]` | ||
Instead you work in `demo-snippets/[ng|react|svelte|vue]` | ||
You can start from the `install.ts` of each flavor to see how to register new demos | ||
|
||
|
||
[](#contributing) | ||
|
||
## Contributing | ||
|
||
### Update repo | ||
|
||
You can update the repo files quite easily | ||
|
||
First update the submodules | ||
|
||
```bash | ||
npm run update | ||
``` | ||
|
||
Then commit the changes | ||
Then update common files | ||
|
||
```bash | ||
npm run sync | ||
``` | ||
Then you can run `yarn|pnpm`, commit changed files if any | ||
|
||
### Update readme | ||
```bash | ||
npm run readme | ||
``` | ||
|
||
### Update doc | ||
```bash | ||
npm run doc | ||
``` | ||
|
||
### Publish | ||
|
||
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release) | ||
Simply run | ||
```shell | ||
npm run publish | ||
``` | ||
|
||
### modifying submodules | ||
|
||
The repo uses https:// for submodules which means you won't be able to push directly into the submodules. | ||
One easy solution is t modify `~/.gitconfig` and add | ||
``` | ||
[url "ssh://[email protected]/"] | ||
pushInsteadOf = https://github.com/ | ||
``` | ||
|
||
|
||
[](#questions) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,3 @@ | ||
/// <reference path="./typings/android.d.ts" /> | ||
/// <reference path="../../node_modules/@nativescript/types-ios/lib/ios/objc-x86_64/objc!UIKit.d.ts" /> | ||
/// <reference path="../../node_modules/@nativescript/types-ios/lib/ios/objc-x86_64/objc!UniformTypeIdentifiers.d.ts" /> |