https://github.com/overextended/fivem-typescript-boilerplate
A boilerplate for building FiveM resources with TypeScript.
https://github.com/overextended/fivem-typescript-boilerplate
boilerplate fivem gta5 typescript
Last synced: 3 months ago
JSON representation
A boilerplate for building FiveM resources with TypeScript.
- Host: GitHub
- URL: https://github.com/overextended/fivem-typescript-boilerplate
- Owner: overextended
- License: unlicense
- Archived: true
- Created: 2024-01-13T07:24:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-24T01:36:49.000Z (6 months ago)
- Last Synced: 2025-06-01T09:23:01.127Z (4 months ago)
- Topics: boilerplate, fivem, gta5, typescript
- Language: TypeScript
- Homepage: https://overextended.dev/
- Size: 137 KB
- Stars: 47
- Watchers: 3
- Forks: 30
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fivem-typescript-boilerplate
A boilerplate for creating FiveM resources with TypeScript.
## Getting Started
### Node.js v18+
Install any LTS release of [`Node.js`](https://nodejs.org/) from v18.
### pnpm
Install the [`pnpm`](https://pnpm.io/installation) package manager globally.
```
npm install -g pnpm
```
### Setup
Initialise your own repository by using one of the options below.
- [Create a new repository](https://github.com/new?template_name=fivem-typescript-boilerplate&template_owner=overextended) using this template.
- [Download](https://github.com/overextended/fivem-typescript-boilerplate/archive/refs/heads/main.zip) the template directly.
- Use the [GitHub CLI](https://cli.github.com/).
- `gh repo create --template=overextended/fivem-typescript-boilerplate`
Navigate to your new directory and execute the following command to install dependencies.
```
pnpm install
```
## Development
Use `pnpm watch` to actively rebuild modified files while developing the resource.
During web development, use `pnpm web:dev` to start vite's webserver and watch for changes.
## Build
Use `pnpm build` to build all project files in production mode.
To build and create GitHub releases, tag your commit (e.g. `v1.0.0`) and push it.
## Layout
- [/dist/](dist)
- Compiled project files.
- [/locales/](locales)
- JSON files used for translations with [ox_lib](https://overextended.dev/ox_lib/Modules/Locale/Shared).
- [/scripts/](scripts)
- Scripts used in the development process, but not part of the compiled resource.
- [/src/](src)
- Project source code.
- [/static/](static)
- Files to include with the resource that aren't compiled or loaded (e.g. config).