Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
pavjacko committed Jul 30, 2024
1 parent e6615ab commit b04b707
Show file tree
Hide file tree
Showing 11 changed files with 89 additions and 291 deletions.
1 change: 0 additions & 1 deletion docs/api/node/rnv/_category_.yml

This file was deleted.

78 changes: 0 additions & 78 deletions docs/api/node/rnv/index.md

This file was deleted.

126 changes: 0 additions & 126 deletions docs/api/node/rnv/modules.md

This file was deleted.

29 changes: 18 additions & 11 deletions docs/guides/develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ At this point your global `rnv` command is linked directly into project above.

It's also best way to contribute back to RNV! :)

```
rnv template apply
=> pick renative-template-hello-world
```

#### Windows development

Expand All @@ -35,6 +31,17 @@ Requirements: Python 2.7, Visual Studio installed or install `windows-build-tool
**Please make sure you follow the package's instructions, especially running it in PowerShell as Administrator**
:::

---
## Testing your project with local RNV

In order to test standalone project with local renative navigate to root of your project and run

```
rnv link
```

All standard rnv commands within the project are now executed by your local renative instance

---
## Deployments

Expand All @@ -50,21 +57,21 @@ npm run deploy:feat

### Alpha

Alpha Releases (from `develop` branches):
Canary Releases (from `develop` branch):

tag format: `0.31.0-alpha.1`
tag & version format: `0.31.0-canary.1`

npm tag `alpha`
npm tag: `next`

```
npm run deploy:alpha
npm run deploy:canary
```

### Production

Production (from `release/xx` branches):

tag format: `0.31.0`
tag & version format: `0.31.0`

npm tag: `latest`

Expand All @@ -77,8 +84,8 @@ npm run deploy:prod

[Documentation for CLI](../api/cli.md)

[Documentation for RNV](../api/node/rnv/modules.md)
[Documentation for RNV Node Library](../api/node/rnv-core/modules.md)

[Documentation for Config](../api/schemas/rnv.project.md)
[Documentation for Config Descriptor](../api/schemas/rnv.project.md)

[Documentation for Runtime](../api/node/renative/modules.md)
56 changes: 1 addition & 55 deletions docs/overview/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ original_id: installation
---
## Requirements

- [Node](https://nodejs.org) `10.13.0` or newer
- [NPM](https://npmjs.com/) `6.4.1` or newer
- [Node](https://nodejs.org) `18.19.1` or newer
- [Android Studio](https://developer.android.com/studio) (if you want to develop for Android)
- [Xcode](https://developer.apple.com/xcode/) (if you want to develop for iOS/tvOS)
- [Tizen Studio](https://developer.tizen.org/ko/development/tizen-studio/configurable-sdk) (if you want to develop for Tizen)
Expand All @@ -24,56 +23,3 @@ original_id: installation
```bash
npm install rnv -g
```

---
## Create new app

<table>
<tr>
<th>
<img src="https://renative.org/img/cli_app_create1.gif" />
</th>
</tr>
</table>

```bash
rnv new
```

Follow steps in the terminal

---
## Run first app

Run your first `ios` app

```bash
rnv run -p ios
```

Run your first `android` app

```bash
rnv run -p android
```

Run your first `web` app

```bash
rnv run -p web
```

... and so on

All app code is located in `./src` directory

---
## NPX

:::info
It is recommended that after initial project setup you start using `npx rnv ...` prefix instead of `rnv ...`

This ensures that every project uses correct version of `rnv` to avoid potential compatibility issues

make sure you have npx installed globally via `npm install npx -g`
:::
Loading

0 comments on commit b04b707

Please sign in to comment.