- First, you need to have the latest git, node 12 or greater installed. OSX, Windows and Linux should all be supported as build environments. This may differ from FiveM's supported environments.
We do not use yarn, so it's not supported.
- For this repo by using the "Fork" button on the upper-right
- Check out your fork
git clone [email protected]:yournamehere/fivem-js.git
- Install or Update all dependencies
npm i
- Get coding! If you've changed or added new functionality, update any relevant documentation. Ensure your work is committed within a feature branch.
- Ensure the project has no linting errors and builds
npm run lint
npm run build
npm i- install and link all packagesnpm run build- builds usingtscnpm run format- autoformats with eslint --fix and prettiernpm run lint- checks for linting issuesnpm run docs- builds documentation