Skip to content

Latest commit

 

History

History
26 lines (23 loc) · 928 Bytes

DEVELOPMENT.md

File metadata and controls

26 lines (23 loc) · 928 Bytes
Raw

Getting Started

  1. 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.

  2. For this repo by using the "Fork" button on the upper-right

  3. Check out your fork

git clone git@github.com:yournamehere/native-wrappers-client.git
  1. Install or Update all dependencies
npm i
  1. Get coding! If you've changed or added new functionality, update any relevant documentation. Ensure your work is committed within a feature branch.
  2. Ensure the project has no linting errors and builds
npm run lint
npm run build

Relevant Commands

  1. npm i - install and link all packages
  2. npm run build - builds using tsc
  3. npm run format - autoformats with eslint --fix and prettier
  4. npm run lint - checks for linting issues
  5. npm run docs - builds documentation