nitro-react/README.md

51 lines
1.8 KiB
Markdown
Raw Normal View History

2022-08-04 04:18:46 +02:00
# Nitro React v2.1
2022-03-15 20:11:57 +01:00
## Prerequisites
2022-08-04 04:18:46 +02:00
- [Git](https://git-scm.com/)
- [NodeJS](https://nodejs.org/) >= 18
- If using NodeJS < 18 remove `--openssl-legacy-provider` from the package.json scripts
- [Yarn](https://yarnpkg.com/) `npm i yarn -g`
2022-03-15 20:11:57 +01:00
## Installation
2022-03-15 20:11:57 +01:00
- 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
2022-03-15 20:11:57 +01:00
## Usage
2022-03-15 20:11:57 +01:00
- To use Nitro you need `.nitro` assets generated, see [nitro-converter](https://git.krews.org/nitro/nitro-converter) for instructions
- See [Morningstar Websockets](https://git.krews.org/nitro/ms-websockets) for instructions on configuring websockets on your server
2022-03-15 20:11:57 +01:00
### Development
2022-03-15 20:11:57 +01:00
Run Nitro in development mode when you are editing the files, this way you can see the changes in your browser instantly
2022-03-15 20:11:57 +01:00
```
yarn start
```
2022-03-15 20:11:57 +01:00
### Production
2022-03-15 20:11:57 +01:00
To build a production version of Nitro just run the following command
2022-03-15 20:11:57 +01:00
```
yarn build:prod
```
- A `dist` folder will be generated, these are the files that must be uploaded to your webserver
2022-03-15 20:11:57 +01:00
- Consult your CMS documentation for compatibility with Nitro and how to add the production files