Logo
Setup
Installation
How to install NX
Developement
How to develop NX
API
API Reference
DiscordGitHub

Setting up

Information

You can help to improve the documentation or the framework by making pull requests at framework or documentation

Important

You need to disable yarn resource otherwise NX is not gonna start

Tools

make sure to have the following tools and successfully installed

Installing dependencies

Clone the repository

clone the repository into your resources folder
git clone https://github.com/niiyy/NX NX

Run the command

navigate to / and run
pnpm i

Building files

Building all

navigate to / and run
pnpm build

Building NUI

navigate to /apps/ui and run
pnpm build

Building Game Scripts

navigate to /apps/rc and run
pnpm build

Building Locales

navigate to /packages/locale and run
pnpm build

Building files

Watching all

to watch all files in FiveM env you need to must navigate to / and run
pnpm dev:ig
to watch all files in browser env you need to navigate to / and run
pnpm dev