Loading...
Loading...
Maintain README files with setup instructions, features, tech stack, and usage examples. Use when updating project documentation, adding new features, improving onboarding, or creating READMEs for new packages.
npx skill4agent add sgcarstrends/sgcarstrends readme-updates# SG Cars Trends
[](LICENSE)
[](https://github.com/sgcarstrends/sgcarstrends/actions)
> Platform for accessing Singapore vehicle registration and COE bidding data
## Features
- 📊 **Comprehensive Data**: Car registration and COE bidding data
- 🔄 **Real-time Updates**: Automated daily updates from LTA DataMall
- 📝 **AI-Generated Blog**: Automated insights using Google Gemini
## Quick Start
\`\`\`bash
git clone https://github.com/sgcarstrends/sgcarstrends.git
cd sgcarstrends
pnpm install
cp .env.example .env
pnpm db:migrate
pnpm dev
\`\`\`
## Tech Stack
- **Frontend**: Next.js 16, HeroUI, Recharts, Tailwind CSS
- **Backend**: Drizzle ORM, PostgreSQL, Upstash Redis
- **Infrastructure**: Vercel
- **AI**: Google Gemini, Vercel AI SDK
## Project Structure
\`\`\`
sgcarstrends/
├── apps/
│ ├── api/ # Hono API
│ └── web/ # Next.js web app
├── packages/
│ ├── database/ # Drizzle schemas
│ ├── ui/ # UI components
│ └── utils/ # Shared utilities
\`\`\`
## Development
\`\`\`bash
pnpm dev # Start all servers
pnpm test # Run tests
pnpm build # Build for production
\`\`\`
## License
MIT# @sgcarstrends/[package-name]
> Brief description
## Installation
\`\`\`bash
pnpm add @sgcarstrends/[package-name]
\`\`\`
## Usage
\`\`\`typescript
import { functionName } from "@sgcarstrends/[package-name]";
const result = functionName();
\`\`\`
## API
### `functionName(param: string): ReturnType`
Description.
**Parameters:** `param` (string) - Description
**Returns:** `ReturnType` - Description
## Development
\`\`\`bash
pnpm test
pnpm build
\`\`\`
## License
MIT[](LICENSE)
[](actions)
[](npm)
[](typescript)## Environment Variables
Create `.env` from `.env.example`:
\`\`\`env
DATABASE_URL=postgresql://user:pass@localhost:5432/db
UPSTASH_REDIS_REST_URL=https://your-redis.upstash.io
UPSTASH_REDIS_REST_TOKEN=your-token
\`\`\`# Check for broken links
pnpm dlx markdown-link-check README.md
# Lint markdown
pnpm dlx markdownlint README.md