From 3e97357561090b38e6643ab9643fa33afa5f9930 Mon Sep 17 00:00:00 2001 From: jango-blockchained Date: Tue, 4 Feb 2025 04:17:58 +0100 Subject: [PATCH] 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 --- docs/GETTING_STARTED.md | 8 ++++---- docs/TESTING.md | 12 ++++++------ 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index 22e56a4..220153c 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -20,7 +20,7 @@ Before you begin, ensure you have: 2. Install dependencies: ```bash - npm install + bun install ``` 3. Copy the example environment file: @@ -57,7 +57,7 @@ Before you begin, ensure you have: For development, you can use: ```bash -npm run dev +bun run dev ``` 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: ```bash -npm run build -npm start +bun run build +bun start ``` ## First Steps diff --git a/docs/TESTING.md b/docs/TESTING.md index 225b147..a5f3db1 100644 --- a/docs/TESTING.md +++ b/docs/TESTING.md @@ -63,25 +63,25 @@ timeout = 30000 # Test timeout in milliseconds testMatch = ["**/__tests__/**/*.test.ts"] # Test file patterns ``` -### NPM Scripts +### Bun Scripts Available test commands in `package.json`: ```bash # Run all tests -npm test # or: bun test +bun test # Watch mode for development -npm run test:watch # or: bun test --watch +bun test --watch # Generate coverage report -npm run test:coverage # or: bun test --coverage +bun test --coverage # Run linting -npm run lint +bun run lint # Format code -npm run format +bun run format ``` ## Test Setup