https://github.com/reactunity/create
Scaffold a React Unity app using "npm init"
https://github.com/reactunity/create
Last synced: about 1 year ago
JSON representation
Scaffold a React Unity app using "npm init"
- Host: GitHub
- URL: https://github.com/reactunity/create
- Owner: ReactUnity
- License: mit
- Created: 2020-03-14T00:26:45.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-22T17:58:47.000Z (about 1 year ago)
- Last Synced: 2025-03-22T18:39:14.420Z (about 1 year ago)
- Language: ShaderLab
- Homepage:
- Size: 2.51 MB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Create React Unity App
Creates the Typescript project for React Unity. See [core library](https://github.com/ReactUnity/core) for details.
## Usage
If you want to add ReactUnity to an existing Unity project:
`npx @reactunity/create@latest`
If you want to create full Unity app from scratch:
`npx @reactunity/create@latest -u`
Create the React project in a custom folder:
`npx @reactunity/create@latest custom/folder/path`
### Options
Options can be used like: `npx @reactunity/create@latest `
```
-u, --unity Creates Unity project from scratch and adds React project into it
-i, --install [npm|yarn] Run 'npm install' or 'yarn install'.
-h, --help Print help
```
## Commands
After a project is created, you can run following commands in the `react` directory. You can also use other package managers like `yarn` instead of `npm`.
- `npm start` - Run development server with HMR support
- `npm run build` - Build the production ready Javascript file to `/Assets/Resources/react/index.js`