Welcome to the RAGE Multiplayer (RAGE MP) Monorepo Boilerplate! This repository provides a starting point for setting up a RAGE MP server with a monorepo structure, making it easier to manage and scale your game server project.

• Monorepo Structure: Organize your server, client, and cef code in a single repository.
• TypeScript Support: Write your scripts in TypeScript for better code quality and maintainability.
• React Support: Using react to create the cef.
• Modular Architecture: Easily add and manage new features or packages.
• Built-in Scripting: Preconfigured scripts to set the ragemp structure automatically.
• Events names package: A monorepo package with enums to prevent mistakes when naming events.

Before you begin, ensure you have the following installed on your machine:

• Node.js (v20.9.0 or upper recommended, may not work with previous versions)
• pnpm

1. Clone the repository:

   git clone https://github.com/yourusername/ragemp-monorepo-boilerplate.git
   cd ragemp-monorepo-boilerplate

   (You can also use this repo as a template in github)

2. Install dependencies:

   pnpm i

3. Add your database connection:

   • Go to apps > server and create a .env file with the following data:

     VITE_DB_HOST= // Database IP
     VITE_DB_NAME= // Database name
     VITE_DB_USERNAME= // Database username
     VITE_DB_PASSWORD= // Database password
     VITE_DB_DIALECT= // Database dialect (Availabe databases with sequelize: Postgres, MySQL, MariaDB, SQLite, Microsoft SQL Server, Oracle)

4. Add your ragemp server files:

   • Add your ragemp server files to the server-files directory, you should delete the client-packages and packages folders.

5. Run build command:

   pnpm run build

   The contents of your dists folders will be automatically moved to their corresponding directory after the build.

   • Server build will go to server-build>packages>server
   • Client will go to server-build>packages_client
   • Cef build will go to server-build>client_packages>cef

6. Start your RageMP server:

   pnpm run start:server

• Add a better architecture for the server, client and cef.
• Add connection to a database.
• Dockerize the monorepository.
• SASS support.
• Add testing (probably vitest).
• Add a system to test the operation of the boilerplate, to serve as an example for anyone to follow from there (Login and registration system).
• Add an event management system between CEF, client and server.

This project is licensed under the MIT License. See the LICENSE file for details.