|
1 | | -<div align="center"> |
| 1 | +# React Unity WebGL Template |
2 | 2 |
|
3 | | - |
4 | | - |
5 | | -[](https://github.com/jeffreylanters/react-unity-webgl-tests/blob/master/LICENSE.md) |
6 | | -[](https://www.npmjs.com/package/react-unity-webgl) |
7 | | -[](https://github.com/jeffreylanters/react-unity-webgl-tests/actions) |
8 | | -[](https://github.com/jeffreylanters/react-unity-webgl-tests/deployments/activity_log?environment=github-pages) |
9 | | -[](https://github.com/jeffreylanters/react-unity-webgl/stargazers) |
10 | | -[](https://www.npmtrends.com/react-unity-webgl) |
11 | | -[](https://bundlephobia.com/result?p=react-unity-webgl) |
12 | | -[](https://github.com/sponsors/jeffreylanters) |
13 | | -[](https://paypal.me/jeffreylanters) |
14 | | - |
15 | | -An out-of-the-box test environment for the React Unity WebGL package. This test environment contains a Create-React-App including a Source and Build Unity WebGL project allowing testing and debugging all of it's features. |
16 | | - |
17 | | -[**Documentation**](#documentation) · |
18 | | -[**Module Repository**](https://github.com/jeffreylanters/react-unity-webgl) · |
19 | | -[**Buy me a Coffee**](https://github.com/sponsors/jeffreylanters) · |
20 | | -[**Discussion Board**](https://github.com/jeffreylanters/react-unity-webgl/discussions) |
21 | | - |
22 | | -**Made with ♥ by Jeffrey Lanters** |
23 | | - |
24 | | -</div> |
25 | | - |
26 | | -# Getting Started |
27 | | - |
28 | | -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). Use the built-in scripts to install and start the repository right away. This runs the app in the development mode. Open [http://localhost:3000](http://localhost:3000) to view it in the browser. The page will reload if you make edits. You will also see any lint errors in the console. |
29 | | - |
30 | | -```sh |
31 | | -$ npm install |
32 | | -$ npm start |
33 | | -``` |
34 | | - |
35 | | -# Documentation |
36 | | - |
37 | | -Hi there and welcome to the React Unity WebGL Test repository! In this repository you'll find everything you'll need for testing and playing with the React Unity WebGL module. This repository is buildt using Create React App for a most basic boilerplate. |
38 | | - |
39 | | -## Template Structure |
40 | | - |
41 | | -Among this project you'll find three directories; |
42 | | - |
43 | | -- "src" Containing the React Application here for you to test and modify |
44 | | -- "public" Containing the Static assets which includes the Unity WebGL build "unitybuild" |
45 | | -- "project" Containing the Raw Unity Project (not required but here for demo purposes) |
46 | | - |
47 | | -## Usage for Module development |
48 | | - |
49 | | -To use this repository for the module development of the React Unity WebGL module, you should remove the react-unity-webgl module using `npm remove react-unity-webgl` and install a manual build instead. For more details on building the module please head over to the React Unity WebGL [Documentation](https://github.com/jeffreylanters/react-unity-webgl#contribution-and-development) for further details on contribution, development and testing. |
| 3 | +An out-of-the-box sandbox environment for the React Unity WebGL package. This environment contains a Create-React-App including both the source and build of a Unity WebGL project, allowing to test and debug all of its features. |
0 commit comments