mirror of https://github.com/billsonnn/nitro-react.git synced 2024-11-26 15:40:51 +01:00

Go to file

billsonnn a893f89066 Fix issue with name bubbles		2024-03-30 10:05:43 -04:00
.vscode	Updates for new renderer	2024-03-20 22:39:51 -04:00
public	Pet package widget (#127 )	2023-01-12 00:51:33 -06:00
src	Fix issue with name bubbles	2024-03-30 10:05:43 -04:00
.browserslistrc	Update build	2021-09-16 00:48:43 -04:00
.eslintrc.json	Vite & Landscapes (#117 )	2023-01-03 01:39:03 -06:00
.gitignore	Vite & Landscapes (#117 )	2023-01-03 01:39:03 -06:00
index.html	Update more things	2024-03-26 22:47:58 -04:00
package.json	Updates for new renderer	2024-03-20 22:39:51 -04:00
README.md	Remove old craco file, rename dist directory	2023-01-03 02:49:39 -05:00
tsconfig.json	Vite & Landscapes (#117 )	2023-01-03 01:39:03 -06:00
vite.config.mjs	Update more things	2024-03-26 22:47:58 -04:00
yarn.lock	Updates for new renderer	2024-03-20 22:39:51 -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 dist 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