docs: update documentation to use Bun commands and scripts
- Replace npm commands with equivalent Bun commands in GETTING_STARTED.md - Update TESTING.md to reflect Bun-specific test and development scripts - Simplify installation, development, and testing instructions
This commit is contained in:
@@ -20,7 +20,7 @@ Before you begin, ensure you have:
|
|||||||
|
|
||||||
2. Install dependencies:
|
2. Install dependencies:
|
||||||
```bash
|
```bash
|
||||||
npm install
|
bun install
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Copy the example environment file:
|
3. Copy the example environment file:
|
||||||
@@ -57,7 +57,7 @@ Before you begin, ensure you have:
|
|||||||
For development, you can use:
|
For development, you can use:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run dev
|
bun run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
This will start the server in development mode with hot reloading.
|
This will start the server in development mode with hot reloading.
|
||||||
@@ -67,8 +67,8 @@ This will start the server in development mode with hot reloading.
|
|||||||
For production, build and start the server:
|
For production, build and start the server:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm run build
|
bun run build
|
||||||
npm start
|
bun start
|
||||||
```
|
```
|
||||||
|
|
||||||
## First Steps
|
## First Steps
|
||||||
|
|||||||
@@ -63,25 +63,25 @@ timeout = 30000 # Test timeout in milliseconds
|
|||||||
testMatch = ["**/__tests__/**/*.test.ts"] # Test file patterns
|
testMatch = ["**/__tests__/**/*.test.ts"] # Test file patterns
|
||||||
```
|
```
|
||||||
|
|
||||||
### NPM Scripts
|
### Bun Scripts
|
||||||
|
|
||||||
Available test commands in `package.json`:
|
Available test commands in `package.json`:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Run all tests
|
# Run all tests
|
||||||
npm test # or: bun test
|
bun test
|
||||||
|
|
||||||
# Watch mode for development
|
# Watch mode for development
|
||||||
npm run test:watch # or: bun test --watch
|
bun test --watch
|
||||||
|
|
||||||
# Generate coverage report
|
# Generate coverage report
|
||||||
npm run test:coverage # or: bun test --coverage
|
bun test --coverage
|
||||||
|
|
||||||
# Run linting
|
# Run linting
|
||||||
npm run lint
|
bun run lint
|
||||||
|
|
||||||
# Format code
|
# Format code
|
||||||
npm run format
|
bun run format
|
||||||
```
|
```
|
||||||
|
|
||||||
## Test Setup
|
## Test Setup
|
||||||
|
|||||||
Reference in New Issue
Block a user