diff --git a/pages/guides/bun.mdx b/pages/guides/bun.mdx new file mode 100644 index 0000000000..90af99507c --- /dev/null +++ b/pages/guides/bun.mdx @@ -0,0 +1,25 @@ +--- +title: bun +--- + +# bun + +bun is a fast and disk space efficient package manager, serving as an alternative to npm, pnpm and yarn. + +- Open a command-line terminal (e.g. Terminal, Command Prompt). +- Enter `curl -fsSL https://bun.sh/install | bash` to install bun on linux. +- Enter `powershell -c "irm bun.sh/install.ps1 | iex"` to insall bun on windows. +- You can install dependencies with bun using `bun i`. + +You can reference `package.json` files for available scripts, i.e. + +```json +"scripts": { + "build": "bun run build.js", + "watch": "bun run build.js --watch", + "format": "bun run biome format --write", + "lint": "bun run biome lint --write" +} +``` + +Using the example above `bun run build` will run the build script for the given package. diff --git a/pages/guides/nodejs.mdx b/pages/guides/nodejs.mdx deleted file mode 100644 index 35391adc74..0000000000 --- a/pages/guides/nodejs.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Node.js ---- - -# Node.js - -Node.js is a JavaScript runtime and is used for building applications. In the context of FiveM it is necessary to bundle resources into a single package that can be ran on both the server and client. - -- [Download](https://nodejs.org) and install the LTS version of Node.js. -- Open a command-line terminal (e.g. Terminal, Command Prompt). -- Enter `node --version` to confirm successful installation. diff --git a/pages/guides/pnpm.mdx b/pages/guides/pnpm.mdx deleted file mode 100644 index 1763805a28..0000000000 --- a/pages/guides/pnpm.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: pnpm ---- - -# pnpm - -pnpm is a fast and disk space efficient package manager, serving as an alternative to npm and yarn. - -- Ensure you have [installed Node.js](./nodejs). -- Open a command-line terminal (e.g. Terminal, Command Prompt). -- Enter `npm install -g pnpm` to globally install the package. -- You can install dependencies with pnpm using `pnpm i`. - -You can reference `package.json` files for available scripts, i.e. - -```json -"scripts": { - "start": "vite", - "watch": "vite build --watch", - "build": "tsc && vite build", - "preview": "vite preview", - "format": "prettier --write \"./src/**/*.{ts,tsx,css}\"" -}, -``` - -Using the example above `pnpm build` will run the build script for the given package. diff --git a/pages/ox_core.mdx b/pages/ox_core.mdx index a3362dcf66..2fb2c0cae1 100644 --- a/pages/ox_core.mdx +++ b/pages/ox_core.mdx @@ -28,15 +28,15 @@ We **strongly** recommend referring to [Guides](../guides) to setup necessary de ### Download the latest [release](https://github.com/communityox/ox_core/releases/latest) or build the source code. -- Setup [Git](../guides/git), [Node.js](../guides/nodejs), and [pnpm](../guides/pnpm). +- Setup [Git](../guides/git), and [bun](../guides/bun). - Download and setup [MariaDB 11.4+](https://mariadb.com/downloads/community/community-server/). - Run the following commands in your CLI (e.g. Terminal, Command Prompt). ```bash git clone https://github.com/communityox/ox_core.git cd ox_core -pnpm i -pnpm build +bun i +bun run build ``` ### Install optional dependencies. @@ -83,7 +83,7 @@ To use ox_core with your JavaScript resources you'll need to use our npm package To get started, try our [fivem-typescript-boilerplate](https://github.com/communityox/fivem-typescript-boilerplate) and install the ox_core package. ```bash -pnpm i @communityox/ox_core +bun i @communityox/ox_core ``` ## Config @@ -96,7 +96,7 @@ These convars should use the `setr` command to be read by clients. - `ox:debug` - Default: `false` - - Enables debug messages and commands. Also allows players to have the same identifiers. Enabled by default when using `pnpm watch`. + - Enables debug messages and commands. Also allows players to have the same identifiers. Enabled by default when using `bun run watch`. - `ox:characterSlots` - Default: `1` - Sets the number of character slots available for character selection resources (e.g. ox_charselect). diff --git a/pages/ox_doorlock.mdx b/pages/ox_doorlock.mdx index 847d945788..08adcf5334 100644 --- a/pages/ox_doorlock.mdx +++ b/pages/ox_doorlock.mdx @@ -12,7 +12,7 @@ A door management resource that can be used standalone or alongside ox_core, qbx -We **strongly** recommend referring to [Guides](../guides) for setting up Git, Node.js, and pnpm. +We **strongly** recommend referring to [Guides](../guides) for setting up Git, and bun. @@ -26,8 +26,8 @@ We **strongly** recommend referring to [Guides](../guides) for setting up Git, N ```bash git clone https://github.com/communityox/ox_doorlock.git cd ox_doorlock/web -pnpm i -pnpm build +bun i +bun run build ``` ### Install optional dependencies. diff --git a/pages/ox_inventory.mdx b/pages/ox_inventory.mdx index 9356057ae3..7c7854f154 100644 --- a/pages/ox_inventory.mdx +++ b/pages/ox_inventory.mdx @@ -19,7 +19,7 @@ If you are unwilling or incapable of resolving incompatibilities, do not install -We **strongly** recommend referring to [Guides](../guides) for setting up Git, Node.js, and pnpm. +We **strongly** recommend referring to [Guides](../guides) for setting up Git, and bun. @@ -33,8 +33,8 @@ We **strongly** recommend referring to [Guides](../guides) for setting up Git, N ```bash git clone https://github.com/communityox/ox_inventory.git cd ox_inventory/web -pnpm i -pnpm build +bun i +bun run build ``` ### Install optional dependencies diff --git a/pages/ox_lib.mdx b/pages/ox_lib.mdx index 973c0c59fe..43d532ccba 100644 --- a/pages/ox_lib.mdx +++ b/pages/ox_lib.mdx @@ -12,7 +12,7 @@ A standalone library for providing easily reusable code as importable modules an -We **strongly** recommend referring to [Guides](../guides) for setting up Git, Node.js, and pnpm. +We **strongly** recommend referring to [Guides](../guides) for setting up Git, and bun. @@ -23,8 +23,8 @@ We **strongly** recommend referring to [Guides](../guides) for setting up Git, N ```bash git clone https://github.com/communityox/ox_lib.git cd ox_lib/web -pnpm i -pnpm build +bun i +bun run build ``` ### Config @@ -144,24 +144,18 @@ If you wish to edit any of the UI elements you will need to download the _source **Requirements:** -- [Node.js (LTS)](https://nodejs.org/) -- pnpm +- bun -**Installing Node.js:** +**Installing bun:** -- Download the LTS version of Node.js. -- Go through the install and make sure you install all of the features. -- Run node --version in cmd and make sure that it gives you the version number. If it doesn't then you didn't install it correctly. - -**Installing pnpm:** - -- After installing NodeJS you can install pnpm by running `npm install -g pnpm`. +- Install bun using `curl -fsSL https://bun.sh/install | bash` for linux +- Install bun using `powershell -c "irm bun.sh/install.ps1 | iex"` for windows **Building the UI:** - cd into the web directory. -- run `pnpm i` to install the dependencies. -- run `pnpm build` to build the source files. +- run `bun i` to install the dependencies. +- run `bun run build` to build the source files. When working in the browser you can run `pnpm start`, which supports hot reloads meaning that diff --git a/pages/ox_target.mdx b/pages/ox_target.mdx index d9200e5a49..429c3db6ea 100644 --- a/pages/ox_target.mdx +++ b/pages/ox_target.mdx @@ -12,7 +12,7 @@ A performant and flexible standalone targeting resource or "third-eye", with add -We **strongly** recommend referring to [Guides](../guides) for setting up Git, Node.js, and pnpm. +We **strongly** recommend referring to [Guides](../guides) for setting up Git, and bun. diff --git a/pages/oxmysql.mdx b/pages/oxmysql.mdx index c28234be5d..b3081978e2 100644 --- a/pages/oxmysql.mdx +++ b/pages/oxmysql.mdx @@ -117,6 +117,9 @@ yarn add @communityox/oxmysql # With npm npm install @communityox/oxmysql + +# With bun +bun install @communityox/oxmysql ``` Import the oxmysql object into your resource.