Update README to reflect Bun as primary runtime and correct D1 database usage

Co-authored-by: ArthurDanjou <29738535+ArthurDanjou@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-12-17 08:39:54 +00:00
parent 87f0b7ba61
commit 92718bfe8e

View File

@@ -106,10 +106,10 @@ curl -O https://api.arthurdanjou.fr/api/resumes/en
### Prerequisites
- Node.js 18+ (or Bun 1.0+ as an alternative runtime)
- pnpm 10.12.1+ (package manager)
- Bun 1.0+ (JavaScript runtime and package manager)
- Alternatively: Node.js 18+ with pnpm 10.12.1+
> **Note:** This project is primarily developed with Node.js and pnpm. Bun can be used as a drop-in replacement for Node.js runtime.
> **Note:** This project uses Bun as the primary runtime and package manager. Node.js with pnpm can be used as an alternative.
### Installation
@@ -119,7 +119,7 @@ git clone https://github.com/ArthurDanjou/artapi.git
cd artapi
# Install dependencies
pnpm install
bun install
```
### Environment Variables
@@ -148,7 +148,7 @@ NUXT_STATUS_PAGE=""
Start the development server on `http://localhost:3000`:
```bash
pnpm dev
bun dev
```
The server will be available at:
@@ -161,13 +161,13 @@ The server will be available at:
Build the application for production:
```bash
pnpm build
bun run build
```
Preview the production build locally:
```bash
pnpm preview
bun preview
```
### Deployment
@@ -179,7 +179,7 @@ Deploy to NuxtHub/Cloudflare:
wrangler login
# Deploy the application
pnpm deploy
bun deploy
```
> **Note:** Make sure you have proper Cloudflare credentials configured. Run `wrangler login` to authenticate if this is your first deployment.
@@ -196,7 +196,7 @@ ArtAPI is built with modern web technologies and follows a serverless architectu
**Data & Content:**
- **Nuxt Content** - Content management with markdown and JSON files
- **better-sqlite3** - SQLite database for content queries
- **Cloudflare D1** - SQLite-compatible database for content queries in production
- **Zod** - Schema validation for API responses
**Additional Features:**
@@ -286,10 +286,10 @@ Check and fix code style issues:
```bash
# Run ESLint
pnpm lint
bun lint
# Auto-fix issues where possible
pnpm lint --fix
bun lint --fix
```
### Type Checking
@@ -338,8 +338,8 @@ content/
### Common Issues
**Q: The development server won't start**
- Ensure you have Node.js 18+ installed
- Try removing `node_modules` and `pnpm-lock.yaml`, then run `pnpm install` again
- Ensure you have Bun 1.0+ installed
- Try removing `node_modules` and `bun.lockb`, then run `bun install` again
- Check if port 3000 is already in use
**Q: Environment variables not working**
@@ -394,7 +394,7 @@ This project uses:
- **TypeScript** for type safety
- **Vue 3** Composition API
Run `pnpm lint` before submitting PRs.
Run `bun lint` before submitting PRs.
### Using as a Template