nitro/nitro-react
1
0
Fork 0
mirror of https://github.com/billsonnn/nitro-react.git synced 2024-11-26 15:40:51 +01:00
Code Issues Packages Projects Releases Wiki Activity
1,449 Commits 7 Branches 3 Tags 11 MiB
TypeScript 82.6%
SCSS 17.3%
51db1f3aa3
Go to file
Bill 51db1f3aa3 Changes
2022-07-23 21:15:24 -04:00
.vscode Changes 2022-07-12 23:17:51 -04:00
public Merge branch 'dev' into @update/room-widgets 2022-04-20 19:46:40 -04:00
src Changes 2022-07-23 21:15:24 -04: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 Fix dumb dev mode issue 2022-03-16 04:43:52 -04:00
package.json Switch from node-sass to sass 2022-07-12 23:56:02 -04:00
README.md Configuration changes 2022-03-15 15:11:57 -04:00
tsconfig.json Update @types/react 2022-05-02 02:34:10 -04:00
yarn.lock Switch from node-sass to sass 2022-07-12 23:56:02 -04:00

README.md

Nitro React

Prerequisites

  • You must have git installed
  • You must have NodeJS >= 16.13 installed
  • We recommend you use Yarn over npm
    • npm i yarn -g

Installation

  • 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

Usage

Development

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

yarn start

Production

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