mirror of
https://github.com/duckietm/Nitro-V3.git
synced 2026-06-19 15:06:20 +00:00
simoleo89
8844cc1328
Until now the test suite was authoritative only when run locally; nothing stopped a commit landing with `yarn test` red. Wire up a GitHub Actions workflow that gates push + pull_request on both `yarn typecheck` and `yarn test --run`. The setup mirrors CLAUDE.md's "Setup walkthrough": - Check the client into `<workspace>/Nitro-V3`. - Check `duckietm/Nitro_Render_V3` as a sibling at `<workspace>/Nitro_Render_V3`, since the build / typecheck wire the renderer in via filesystem aliases that expect that layout. - Symlink `Nitro-V3/node_modules/@nitrots/nitro-renderer` → `../../../Nitro_Render_V3` so `tsconfig.json`'s `include` entry pointing at `node_modules/@nitrots/nitro-renderer/src/**/*.ts` actually resolves. - `yarn install --frozen-lockfile` in both repos, then run `yarn typecheck` and `yarn test --run` in the client. Node 22 (matches the local toolchain). Yarn classic, with the workflow's `setup-node` caching the `yarn.lock` of both repos so subsequent runs don't reinstall from scratch. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
v2.2.0 -Nitro V3 !! Use at Own Risk as it is still in Beta !!
Prerequisites
- Git
- NodeJS >= 18
- If using NodeJS < 18 remove
--openssl-legacy-providerfrom the package.json scripts
- If using NodeJS < 18 remove
- Yarn
npm i yarn -g
Installation
- First you should open terminal and navigate to the folder where you want to clone Nitro and Nitro-Renderer
- Clone Nitro (Expl. C:\Github)
git clone https://github.com/duckietm/Nitro-V3.git<== For now switch to Dev-RendererV2git clone https://github.com/duckietm/Nitro_Render_V3.git- Install the dependencies for the renderer : cd C:\Github\Nitro_Render_V3
yarn install
- Now we will create a Link for the Nitro Renderer :
yarn linkThis will give you a link addressyarn link "@nitrots/nitro-renderer" - Install the dependencies for Cool UI : cd C:\Github\Nitro-V3
yarn installyarn link "@nitrots/nitro-renderer"<== This will link the renderer in the project
- Rename a few files
- Copy
public/configuration/renderer-config.exampletopublic/configuration/renderer-config.json - Copy
public/configuration/ui-config.exampletopublic/configuration/ui-config.json - Copy
public/configuration/client-mode.exampletopublic/configuration/client-mode.json - Set your links
- Open
public/configuration/renderer-config.json- Update
socket.url, asset.url, image.library.url, & hof.furni.url
- Update
- Open
public/configuration/ui-config.json- Update
camera.url, thumbnails.url, url.prefix, habbopages.url
- Update
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
NitroConfigin the index.html
- Copy
Usage
- To use Nitro you need
.nitroassets generated, see nitro-converter for instructions - See Morningstar Websockets for instructions on configuring websockets on your server
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
distfolder 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