entityseven/rage-framework
2
2
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

upd 0.1.1

rilaxik 2024-10-30 18:08:49 +00:00
parent d8d33bacfa
commit 874d10945d
1 changed files with 23 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
CLI%400.1.1.md

@ -1,27 +1,39 @@
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/)
``pnpm create rage-fw@latest``
``pnpm create @entityseven/rage-fw@latest``
## TL;DR
# TL;DR
- ``Initialize new project`` - create new template project
- ``Test our RPC`` - scaffold an example for ``@entityseven/rage-fw-rpc``
- ``Install RAGE:MP updater`` - download and update RAGE:MP server files
## Options
# Options
For now, you will see a few available options. They are described in detail below
- ``Initialize new project``
- ``Test our RPC``
- ``Install RAGE:MP updater``
### Initialize new project
Using this options will forward you to common project-creation menu
## 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**
This option will specify a name for your project which is used as a folder name too. Defaults to **rage-fw**
- ``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
- ``Select frontend``
## Test our RPC
Using this option will forward you to common project creation menu
Use this selector menu to choose which frontend framework you want to use. We will do our best to expand this menu after some time.
Defaults to **React + TypeScript (Vite)**
- ``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**
### Install Rage:MP updater
This option will simplify installation process of Rage:MP server files required to start your server
- ``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
## Install Rage:MP updater
This option will simplify installation and update process of Rage:MP server files required to start your server
# Contribution
If you wish to help us in expanding examples selection with different framework you are very welcome to open PRs and Issues