duckietm/Nitro-Cool-UI
1
0
Fork 0
mirror of https://github.com/duckietm/Nitro-Cool-UI.git synced 2025-06-21 22:36:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

update ReadMe

Browse Source
This commit is contained in:
duckietm 2024-04-25 16:47:29 +02:00
parent e5a2d527fa
commit e4130518e1
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,4 +1,4 @@
# Nitro React v2.1 # v2.2.0 - Cool UI Beta !! Use at Own Risk as it is still in Beta !!
## Prerequisites ## Prerequisites
@ -9,12 +9,16 @@
## Installation ## Installation
- First you should open terminal and navigate to the folder where you want to clone Nitro - First you should open terminal and navigate to the folder where you want to clone Nitro and Nitro-Renderer
- Clone Nitro - Clone Nitro (Expl. C:\Github\)
- `git clone https://git.krews.org/nitro/nitro-react.git` - `git clone https://github.com/duckietm/Nitro-Cool-UI.git` <== For now switch to Dev-RendererV2
- Install the dependencies - `git clone https://github.com/duckietm/Nitro-Cool-UI-Renderer.git`
- Install the dependencies for the renderer : cd C:\Github\Nitro-Cool-UI-Renderer
- `yarn install` - `yarn install`
- This may take some time, please be patient - Now we will create a Link for the CoolUI : `yarn link` This will give you a link address `yarn link "@nitrots/nitro-renderer"`
- Install the dependencies for Cool UI : cd C:\Github\Nitro-Cool-UI
- `yarn install`
- `yarn "@nitrots/nitro-renderer` <== This will link the renderer in the project
- Rename a few files - Rename a few files
- Rename `public/renderer-config.json.example` to `public/renderer-config.json` - Rename `public/renderer-config.json.example` to `public/renderer-config.json`
- Rename `public/ui-config.json.example` to `public/ui-config.json` - Rename `public/ui-config.json.example` to `public/ui-config.json`
@ -23,6 +27,7 @@
- Update `socket.url, asset.url, image.library.url, & hof.furni.url` - Update `socket.url, asset.url, image.library.url, & hof.furni.url`
- Open `public/ui-config.json` - Open `public/ui-config.json`
- Update `camera.url, thumbnails.url, url.prefix, habbopages.url` - Update `camera.url, thumbnails.url, url.prefix, habbopages.url`
- `yarn build` <== the final step to build the DIST folder this is where your browser needs to point / or upload this to your /client if you do the compile on a other machine (preferd)
- You can override any variable by passing it to `NitroConfig` in the index.html - You can override any variable by passing it to `NitroConfig` in the index.html
## Usage ## Usage
@ -47,4 +52,4 @@ yarn build:prod
``` ```
- A `dist` folder will be generated, these are the files that must be uploaded to your webserver - 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 - Consult your CMS documentation for compatibility with Nitro and how to add the production files