florianv85 / altv-typescript-react

A Typescript Boilerplate for alt:V with simple setup and usage. Includes React with Vite.

Typescript Boilerplate for alt:V with React - v5.0.1

^{Super Fast Compilation}

💡 Need a Roleplay Script? Try Athena!

Features

A simple Typescript Boilerplate that builds incredibly fast using the SWC Library.

• Auto Refresh Server
• Auto Compile TypeScript Files
• Auto Download Resources
• Single Resource Code Support
• Fastest Auto Reconnect Time on Recompile
• Compile Multiple Resources at Once
• Built-in React for WebViews

Installation

• Install NodeJS 18+
• Install GIT

Clone the Repository

Use the command below in any terminal, command prompt, etc.

git clone https://github.com/Stuyk/altv-typescript-react

Install the Repository

Use the command below in any terminal, command prompt, etc.

cd altv-typescript-react
npm install

Download Server Files

Use the command below in any terminal, command prompt, etc. This will download all necessary server files from an additional package used by this project.

npm run update

Start Production Server (Windows)

Run this command to run the server in production mode.

npm run windows

Start Production Server (Linux)

Run this command to run the server in production mode.

npm run linux

Start Developer Server

Run this command to run the server in development mode.

This will automatically reconnect your alt:V Client if you have debug mode turned on.

npm run dev

WebView Previews

If you need to modify the WebView and want to work out of the browser, use the following command.

npm run react-dev

End Server Runtime

Use the key combination ctrl + c to kill your server in your terminal, command prompt, etc.

How to Add Mods, and New Resources

Always add your already compiled resources & mods into the resources folder.

How to ignore specific resources from compiling

Add file name .nocompile to the resource folder you want to ignore from compiling.