arthur/artmcp
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/artmcp.git synced 2026-01-14 14:44:21 +01:00
Code Issues 1 Packages Projects Releases Wiki Activity

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

Browse Source 
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
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

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