๐ฅ A Typescript Boilerplate for FiveM ๐ฎ
This is a basic boilerplate for creating a FiveM resource using Typescript. It includes webpack config files, linting (ESlint + prettier) and a directory structure to get you started. We recommend to use fivem-js alongside this boilerplate for faster development of client scripts.
- Clone repository into your
resources/[local]
folder. npm i
the dependencies.- Start development.
Use npm run watch
to watch files during development.
Build your production ready code with npm run build
.
This will build the client and server script with the --mode production
flag.
The fxmanifest.lua
is not setup to automatically build upon first FXServer start. If you'd like to setup automatic builds you must add the following to your fxmanifest.lua
.
dependency 'yarn'
dependency 'webpack'
webpack_config 'webpack.config.js'
However, due to the speed performance of the pre-packaged webpack/yarn of cfx-server-data, we suggest you don't do this and build manually as described previously ("Production").
This product is MIT licensed. Please make sure you give credit and include this license in your product.