Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
ruchernchong committed Dec 15, 2024
1 parent f683db1 commit ed5e067
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 12 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"test:coverage": "vitest run --coverage",
"migrate": "drizzle-kit migrate"
},
"author": "Ru Chern CHONG <[email protected]>",
"author": "Ru Chern Chong <[email protected]>",
"license": "ISC",
"dependencies": {
"@neondatabase/serverless": "^0.10.4",
Expand All @@ -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"
}
}
10 changes: 0 additions & 10 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ed5e067

Please sign in to comment.