diff --git a/README.md b/README.md new file mode 100644 index 0000000..6587c88 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# Updater + +## Description + +A serverless application for updating car trends data. + +## Prerequisites + +- Node.js (compatible with Node 22.x) +- pnpm + +## Installation + +```bash +pnpm install +``` + +## Scripts + +- `pnpm dev`: Start development server using SST (Serverless Stack) in dev stage +- `pnpm test`: Run tests using Vitest +- `pnpm test:coverage`: Run tests with coverage report +- `pnpm migrate`: Run database migrations using Drizzle Kit + +## Key Dependencies + +- Hono (Web framework) +- Drizzle ORM +- Neon Database Serverless +- Upstash Redis + +## Development Tools + +- Vitest (Testing) +- Biome (Linting) + +## Database Migrations + +Migrations are managed using Drizzle Kit. Run `pnpm migrate` to apply database schema changes. + +## License + +ISC + +## Author + +Ru Chern Chong diff --git a/package.json b/package.json index e1d3fc8..b9b888f 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "test:coverage": "vitest run --coverage", "migrate": "drizzle-kit migrate" }, - "author": "Ru Chern CHONG ", + "author": "Ru Chern Chong ", "license": "ISC", "dependencies": { "@neondatabase/serverless": "^0.10.4", @@ -27,7 +27,6 @@ "@types/papaparse": "^5.3.15", "@vitest/coverage-v8": "2.1.8", "drizzle-kit": "^0.29.0", - "prettier": "^3.4.1", "vitest": "^2.1.8" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 076c2c4..2469d7b 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -51,9 +51,6 @@ importers: drizzle-kit: specifier: ^0.29.0 version: 0.29.0 - prettier: - specifier: ^3.4.1 - version: 3.4.1 vitest: specifier: ^2.1.8 version: 2.1.8(@types/node@22.10.1) @@ -1124,11 +1121,6 @@ packages: postgres-range@1.1.4: resolution: {integrity: sha512-i/hbxIE9803Alj/6ytL7UHQxRvZkI9O4Sy+J3HGc4F4oo/2eQAjTSNJ0bfxyse3bH0nuVesCk+3IRLaMtG3H6w==} - prettier@3.4.1: - resolution: {integrity: sha512-G+YdqtITVZmOJje6QkXQWzl3fSfMxFwm1tjTyo9exhkmWSqC4Yhd1+lug++IlR2mvRVAxEDDWYkQdeSztajqgg==} - engines: {node: '>=14'} - hasBin: true - resolve-pkg-maps@1.0.0: resolution: {integrity: sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==} @@ -2113,8 +2105,6 @@ snapshots: postgres-range@1.1.4: {} - prettier@3.4.1: {} - resolve-pkg-maps@1.0.0: {} rollup@4.28.1: