{"id":16590071,"url":"https://github.com/leonardssh/ragemp-typescript","last_synced_at":"2025-03-21T13:31:11.307Z","repository":{"id":45477756,"uuid":"432192147","full_name":"leonardssh/ragemp-typescript","owner":"leonardssh","description":"A Typescript Boilerplate for RAGE:MP with simple setup and usage.","archived":false,"fork":false,"pushed_at":"2023-12-21T11:42:06.000Z","size":89,"stargazers_count":44,"open_issues_count":3,"forks_count":12,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-18T01:43:03.699Z","etag":null,"topics":["nodejs","ragemp","typescript"],"latest_commit_sha":null,"homepage":"https://rage.mp","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leonardssh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-26T13:41:45.000Z","updated_at":"2025-03-02T03:21:51.000Z","dependencies_parsed_at":"2024-10-28T10:27:13.909Z","dependency_job_id":"2ca12948-9b94-418f-a6a5-6d284381c2df","html_url":"https://github.com/leonardssh/ragemp-typescript","commit_stats":null,"previous_names":[],"tags_count":6,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leonardssh%2Fragemp-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leonardssh%2Fragemp-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leonardssh%2Fragemp-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leonardssh%2Fragemp-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leonardssh","download_url":"https://codeload.github.com/leonardssh/ragemp-typescript/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244806081,"owners_count":20513375,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nodejs","ragemp","typescript"],"created_at":"2024-10-11T23:10:51.110Z","updated_at":"2025-03-21T13:31:10.940Z","avatar_url":"https://github.com/leonardssh.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\" style=\"font-size: 26px\"\u003e\n\t\u003cb\u003eA Typescript Boilerplate for RAGE:MP with simple setup and usage.\u003c/b\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\nRemember to 🌟 this Github if you 💖 it.\n\n\u003e For Javascript Edition, see: [ragemp-javascript](https://github.com/leonardssh/ragemp-javascript)\n\n## 📌 Features\n\n-   Full RAGE:MP Type Support for VSCode\n-   Built in rollup config for transpile and auto-copy (incredibly fast using the [SWC](https://github.com/swc-project/swc))\n-   Prettier Configuration for code formatting.\n\n## 📥 Installation\n\n### Prerequisites\n\n-   [Install NodeJS 16+](https://nodejs.org/en/download/current/)\n-   [Install GIT](https://git-scm.com/downloads)\n\n### Clone the Repository\n\nUse the command below in any terminal, command prompt, etc.\n\n```sh\ngit clone https://github.com/leonardssh/ragemp-typescript.git\n```\n\n### Install the necessary modules\n\nUse the command below in any terminal, command prompt, etc.\n\n```sh\ncd ragemp-typescript\nnpm install\n```\n\n### Rename the `.env.example` file to `.env`\n\nWithout it, rollup will not be able to copy the files properly\n\n### Compiler Configuration\n\nThe boilerplate comes with 2 compilers:\n\n1. [SWC](https://swc.rs/) - ⚡ultra fast (no support for const enums)\n2. [Typescript](https://www.npmjs.com/package/rollup-plugin-typescript2) - 🐢 very slow (support for const enums)\n\n\u003e To use SWC, set `COMPILER_USE_SWC` to true, and for `TYPESCRIPT` to false\n\n```bash\nPRODUCTION_MODE=false\nCOMPILER_USE_SWC=true // \u003c--- CHANGE THE COMPILER BETWEEN SWC \u0026 TYPESCRIPT\n```\n\n### Build the server\n\nUse the command below in any terminal, command prompt, etc. This will transpile and copy the files to the `dist` folder. Folder which is used for production.\n\n```sh\nnpm run build\n```\n\n![](https://i.imgur.com/p6hbXmg.png)\n\n### Get Server Files\n\nGrab the server files from `RAGEMP/server-files` and drop them in the `dist` folder.\n\n### Start the Server\n\n```sh\ncd ./dist\n./ragemp-server.exe\n```\n\n## 👨‍💻 Contributing\n\nTo contribute to this repository, feel free to create a new fork of the repository and submit a pull request.\n\n1. Fork / Clone and select the `main` branch.\n2. Create a new branch in your fork.\n3. Make your changes.\n4. Commit your changes, and push them.\n5. Submit a Pull Request [here](https://github.com/LeonardSSH/ragemp-typescript/pulls)!\n\n## 📋 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleonardssh%2Fragemp-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleonardssh%2Fragemp-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleonardssh%2Fragemp-typescript/lists"}