rage-framework/cli/readme.md

41 lines
1.7 KiB
Markdown
Raw Normal View History

To make you life easier while using RageFW we created a basic CLI. At the moment automation we have only works via [pnpm](https://pnpm.io/) and [bun](https://bun.sh/)
2024-06-14 16:58:04 +00:00
2024-10-28 13:20:51 +00:00
``pnpm create @entityseven/rage-fw@latest``
2024-06-14 16:58:04 +00:00
``bun create @entityseven/rage-fw@latest``
# TL;DR
2024-06-14 16:58:04 +00:00
- ``Initialize new project`` - create new template project
- ``Test our RPC`` - scaffold an example for ``@entityseven/rage-fw-rpc``
2024-06-14 16:58:04 +00:00
- ``Install RAGE:MP updater`` - download and update RAGE:MP server files
# Options
2024-06-14 16:58:04 +00:00
For now, you will see a few available options. They are described in detail below
- ``Initialize new project``
- ``Test our RPC``
2024-06-14 16:58:04 +00:00
- ``Install RAGE:MP updater``
## Initialize new project
Using this option will forward you to common project creation menu
- ``Enter project name``
This option will specify a name for your project which is used as a folder name too. Defaults to **rage-fw-example**
- ``Select front-end``
Use selector menu to choose which front-end framework you want to use. We will do our best to expand this menu with various solutions
## Test our RPC
Using this option will forward you to common project creation menu
2024-06-14 16:58:04 +00:00
- ``Enter project name``
This option will specify a name for your project which is used as a folder name too. Defaults to **rage-fw-rpc-example**
2024-06-14 16:58:04 +00:00
- ``Select front-end``
Use selector menu to choose which front-end framework you want to use. We will do our best to expand this menu with various solutions
2024-06-14 16:58:04 +00:00
## Install Rage:MP updater
This option will simplify installation and update process of Rage:MP server files required to start your server
2024-06-14 16:58:04 +00:00
# Contribution
If you wish to help us in expanding examples selection with different framework you are very welcome to open PRs and Issues