# generator-oxy-gen

> Yeoman generator for Electron app with React and Rust (WASM).

Latest version **1.0.3** (published 2018-12-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install generator-oxy-gen
pnpm add generator-oxy-gen
yarn add generator-oxy-gen
bun add generator-oxy-gen
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2018-12-23 |
| First published | 2018-12-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 488.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andrew Steinheiser |
| Maintainers | asteinheiser |
| Keywords | yeoman, react, rust, electron, web-assembly, wasm, web-workers |

## Links

- npm: https://www.npmjs.com/package/generator-oxy-gen
- npm.io page: https://npm.io/package/generator-oxy-gen

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [lodash.kebabcase](https://npm.io/package/lodash.kebabcase.md) ^4.1.1
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^3.1.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2018-12-23
- 1.0.2 — 2018-12-23
- 1.0.1 — 2018-12-21
- 1.0.0 — 2018-12-21

## README

# generator-oxy-gen
OXY-GEN is an open-source cli tool that helps developers quickly create native desktop apps using React and Rust!

Here is a [demo project](https://github.com/ASteinheiser/oxy-gen-demo) generated with this generator.

<img src="https://raw.githubusercontent.com/ASteinheiser/generator-oxy-gen/master/OXY-GEN%20Demo%20Screenshot.png" alt="OXY-GEN Demo Screenshot" width="600"/>

# Features
- Generator built with [Yeoman](https://yeoman.io/)
- Uses [create-react-app](https://facebook.github.io/create-react-app/) to generate a fresh [React](https://reactjs.org/) project
- Builds cross platform app with [Electron](https://electronjs.org/)
- Compiles [Rust](https://www.rust-lang.org/) to [Web Assembly](https://webassembly.org/)
- Comes with [multithreading](https://en.wikipedia.org/wiki/Multithreading_(computer_architecture)) example via [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers)

# Get Started!
## Install CRA (>= v2.1.0)
```
npm install -g create-react-app
```
## Rust Toolchain
### Install Rustup
```
curl https://sh.rustup.rs -sSf | sh
source $HOME/.cargo/env
```
### Select Nightly Version (for WASM support)
```
rustup default nightly
```
### Install WASM bindgen and add target
```
rustup target add wasm32-unknown-unknown
cargo install wasm-bindgen-cli
```
## Install Yeoman
```
npm install -g yo
```
## Install this Generator
```
npm install -g generator-oxy-gen
```

# Usage
```
yo oxy-gen
```
#### OR

Run the command with `--force` to overwrite the appropriate files during generation. Otherwise, the user will need to approve each file (Theres's only about 5 or so).
```
yo oxy-gen --force
```
And if you prefer `yarn` to `npm`, you can use the `--yarn` flag to set your default package manager.
```
yo oxy-gen --yarn
```

---
_Source: https://npm.io/package/generator-oxy-gen · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._