Update contribution guidelines for Bun usage
This commit is contained in:
parent
b2e836e386
commit
601262b70f
1 changed files with 8 additions and 7 deletions
|
|
@ -5,16 +5,17 @@ This project uses [Vite](https://vitejs.dev/) for local development and optimize
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- [Node.js](https://nodejs.org/) (Version 20+ or 22+ recommended)
|
- [Node.js](https://nodejs.org/) (Version 20+ or 22+ recommended)
|
||||||
|
- [Bun](https://bun.sh/) (or [npm](https://www.npmjs.com/))
|
||||||
|
|
||||||
### Getting Started
|
### Getting Started
|
||||||
|
|
||||||
1. Install dependencies:
|
1. Install dependencies:
|
||||||
```bash
|
```bash
|
||||||
npm install
|
bun install
|
||||||
```
|
```
|
||||||
2. Start the development server:
|
2. Start the development server:
|
||||||
```bash
|
```bash
|
||||||
npm run dev
|
bun run dev
|
||||||
```
|
```
|
||||||
The app will be available at `http://localhost:5173/`.
|
The app will be available at `http://localhost:5173/`.
|
||||||
|
|
||||||
|
|
@ -35,13 +36,13 @@ We use a standard stack to ensure code quality and consistency:
|
||||||
|
|
||||||
### Commands
|
### Commands
|
||||||
|
|
||||||
- **Check everything:** `npm run lint`
|
- **Check everything:** `bun run lint`
|
||||||
- **Auto-format code:** `npm run format` (Runs Prettier)
|
- **Auto-format code:** `bun run format` (Runs Prettier)
|
||||||
- **Fix JS issues:** `npm run lint:js -- --fix`
|
- **Fix JS issues:** `bun run lint:js -- --fix`
|
||||||
- **Fix CSS issues:** `npm run lint:css -- --fix`
|
- **Fix CSS issues:** `bun run lint:css -- --fix`
|
||||||
|
|
||||||
> [!IMPORTANT]
|
> [!IMPORTANT]
|
||||||
> A GitHub Action automatically runs these checks on every push and pull request. Please ensure `npm run lint` passes before committing.
|
> A GitHub Action automatically runs these checks on every push and pull request. Please ensure `bun run lint` passes before committing.
|
||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue