https://github.com/bur4kbey/fivem-typescript-template
A template for FiveM using TypeScript
https://github.com/bur4kbey/fivem-typescript-template
fivem qbcore react tailwindcss typescript vite
Last synced: 6 months ago
JSON representation
A template for FiveM using TypeScript
- Host: GitHub
- URL: https://github.com/bur4kbey/fivem-typescript-template
- Owner: BUR4KBEY
- License: mit
- Created: 2023-02-07T13:23:02.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-14T01:49:42.000Z (over 1 year ago)
- Last Synced: 2025-03-30T15:38:47.411Z (9 months ago)
- Topics: fivem, qbcore, react, tailwindcss, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 89.8 KB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FiveM Typescript Template
This template had inspired by [**project-error/fivem-typescript-boilerplate**](https://github.com/project-error/fivem-typescript-boilerplate) and customized for general usage.
This template uses [**React**](https://reactjs.org/) (with [**Vite**](https://vitejs.dev/)), [**TailwindCSS**](https://tailwindcss.com/) and [**QBCore**](https://docs.qbcore.org/qbcore-documentation/) with Typescript.
## Folder Structure
- `client`: Client-side scripts
- `server`: Server-side scripts
- `web`: Front-end files
- `scripts`: Helpful scripts for the project
- `dist`: Builded version of `client` and `server`
## Installation
- Install `yarn` if you haven't installed it yet. (`npm install yarn -g`)
- Go to `server-data/resources/[my-resources]`
- Run `git clone https://github.com/BUR4KBEY/fivem-typescript-template template`
- Run these commands:
```powershell
cd template
yarn install
cd web
yarn install
yarn build
cd..
yarn build
```
- Type these commands to FiveM console:
```
refresh
ensure template
```
If the installation succeeds, you can use `template` command in the game. (F8 > `template`)
## Development
- You can develop the UI using `dev` command (in `web` folder) on browser. After you finish the development process, you can run `build` command to build.
- You can use `watch` command to build your `server` and `client` folders automatically.
## ☕ Support
If you find this project useful and would like to support [me](https://github.com/BUR4KBEY), you can do so by visiting [my website](https://burakbey.dev).
