mirror of https://github.com/billsonnn/nitro-react.git synced 2024-11-22 22:30:52 +01:00

Go to file

Bill b91f5eaed8 Merge branch 'fix-wired-wearing-avatar-effect' into 'dev' Fix issue #261 - WiredConditionActorIsWearingEffectView See merge request nitro/nitro-react!87		2022-10-16 00:49:24 +00:00
.vscode	Changes	2022-07-12 23:17:51 -04:00
public	Merge branch '@feature/catalog-changes' into '@fix/fixes'	2022-08-18 03:10:21 +00:00
src	Merge branch 'fix-wired-wearing-avatar-effect' into 'dev'	2022-10-16 00:49:24 +00:00
.browserslistrc	Update build	2021-09-16 00:48:43 -04:00
.editorconfig	First commit	2021-04-14 14:24:24 -04:00
.eslintrc.json	Updates	2022-04-03 22:45:47 -04:00
.gitignore	Merge branch 'dev' into more-layout-changes	2022-01-07 19:52:41 -05:00
.gitlab-ci.yml-disabled	Disable CI for now	2022-03-16 12:25:19 -04:00
craco.config.js	Update dependencies	2022-07-25 11:45:51 -04:00
package.json	Bump version 2.1.1	2022-08-18 12:30:51 -04:00
README.md	Version 2.1.0	2022-08-03 22:18:46 -04:00
tsconfig.json	Update @types/react	2022-05-02 02:34:10 -04:00
yarn.lock	Bump renderer version	2022-08-03 22:07:23 -04:00

Nitro React v2.1

Prerequisites

Git
NodeJS >= 18
- If using NodeJS < 18 remove --openssl-legacy-provider from the package.json scripts
Yarn npm i yarn -g

First you should open terminal and navigate to the folder where you want to clone Nitro
Clone Nitro
- git clone https://git.krews.org/nitro/nitro-react.git
Install the dependencies
- yarn install
- This may take some time, please be patient
Rename a few files
- Rename public/renderer-config.json.example to public/renderer-config.json
- Rename public/ui-config.json.example to public/ui-config.json
Set your links
- Open public/renderer-config.json
  - Update socket.url, asset.url, image.library.url, & hof.furni.url
- Open public/ui-config.json
  - Update camera.url, thumbnails.url, url.prefix, habbopages.url
- You can override any variable by passing it to NitroConfig in the index.html

To use Nitro you need .nitro assets generated, see nitro-converter for instructions
See Morningstar Websockets for instructions on configuring websockets on your server

Run Nitro in development mode when you are editing the files, this way you can see the changes in your browser instantly

yarn start

To build a production version of Nitro just run the following command

yarn build:prod

A build folder will be generated, these are the files that must be uploaded to your webserver
Consult your CMS documentation for compatibility with Nitro and how to add the production files