An open API service indexing awesome lists of open source software.

https://github.com/forwardsoftware/react-native-toolbox

A set of scripts to simplify React Native development
https://github.com/forwardsoftware/react-native-toolbox

cli development-tools react-native scripts utilities utils

Last synced: 11 months ago
JSON representation

A set of scripts to simplify React Native development

Awesome Lists containing this project

README

          

React Native Toolbox
=====================

> A set of scripts to simplify React Native development

[![License](https://img.shields.io/npm/l/@forward-software/react-native-toolbox.svg)](https://github.com/forwardsoftware/react-native-toolbox/blob/main/LICENSE) [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/@forward-software/react-native-toolbox.svg)](https://npmjs.org/package/@forward-software/react-native-toolbox) [![Downloads/week](https://img.shields.io/npm/dw/@forward-software/react-native-toolbox.svg)](https://npmjs.org/package/@forward-software/react-native-toolbox)

* [Install](#install)
* [Commands](#commands)

# Install

```bash
yarn add -D @forward-software/react-native-toolbox
```

or use it directly with

```bash
npx @forward-software/react-native-toolbox
```

# Commands

* [`rn-toolbox dotenv ENVIRONMENTNAME`](#rn-toolbox-dotenv-environmentname)
* [`rn-toolbox help [COMMAND]`](#rn-toolbox-help-command)
* [`rn-toolbox icons [FILE]`](#rn-toolbox-icons-file)
* [`rn-toolbox splash [FILE]`](#rn-toolbox-splash-file)

## `rn-toolbox dotenv ENVIRONMENTNAME`

manage .env files for react-native-dotenv

```
USAGE
$ rn-toolbox dotenv ENVIRONMENTNAME [-h]

ARGUMENTS
ENVIRONMENTNAME name of the environment to load .dotenv file for

FLAGS
-h, --help Show CLI help.

DESCRIPTION
manage .env files for react-native-dotenv
Manage .env files for react-native-dotenv for a specific environment (development, production, etc...)

EXAMPLES
$ rn-toolbox dotenv
```

_See code: [src/commands/dotenv.ts](https://github.com/forwardsoftware/react-native-toolbox/blob/v3.0.0/src/commands/dotenv.ts)_

## `rn-toolbox help [COMMAND]`

Display help for rn-toolbox.

```
USAGE
$ rn-toolbox help [COMMAND...] [-n]

ARGUMENTS
COMMAND... Command to show help for.

FLAGS
-n, --nested-commands Include all nested commands in the output.

DESCRIPTION
Display help for rn-toolbox.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.25/src/commands/help.ts)_

## `rn-toolbox icons [FILE]`

generate app icons

```
USAGE
$ rn-toolbox icons [FILE] [-a ] [-h]

ARGUMENTS
FILE [default: ./assets/icon.png] input icon file

FLAGS
-a, --appName= the appName used to build output assets path. Default is retrieved from 'app.json' file.
-h, --help Show CLI help.

DESCRIPTION
generate app icons
Generate app icons using FILE as base.
The base icon file should be at least 1024x1024px.

EXAMPLES
$ rn-toolbox icons
```

_See code: [src/commands/icons.ts](https://github.com/forwardsoftware/react-native-toolbox/blob/v3.0.0/src/commands/icons.ts)_

## `rn-toolbox splash [FILE]`

generate app splashscreen for react-native-splash-screen

```
USAGE
$ rn-toolbox splash [FILE] [-a ] [-h]

ARGUMENTS
FILE [default: ./assets/splashscreen.png] input splashscreen file

FLAGS
-a, --appName= the appName used to build output assets path. Default is retrieved from 'app.json' file.
-h, --help Show CLI help.

DESCRIPTION
generate app splashscreen for react-native-splash-screen
Generate app splashscreen using FILE as base to be used with crazycodeboy/react-native-splash-screen module.
The base splashscreen file should be at least 1242x2208px.

EXAMPLES
$ rn-toolbox splash
```

_See code: [src/commands/splash.ts](https://github.com/forwardsoftware/react-native-toolbox/blob/v3.0.0/src/commands/splash.ts)_

## License

Mozilla Public License 2.0

---

Made with ✨ & ❤️ by [ForWarD Software](https://github.com/forwardsoftware) and [contributors](https://github.com/forwardsoftware/react-native-toolbox/graphs/contributors)

If you found this project to be helpful, please consider contacting us to develop your React and React Native projects.