initialised repo
This commit is contained in:
51
README.md
Normal file
51
README.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# AutoDork - Next.js + shadcn/ui
|
||||
|
||||
AI-powered product research tool with a landing page, onboarding flow, and dashboard.
|
||||
|
||||
## URL Structure
|
||||
|
||||
| Route | Description |
|
||||
|-------|-------------|
|
||||
| `/` | Landing page with marketing content |
|
||||
| `/onboarding` | Enter website URL & analyze product |
|
||||
| `/dashboard` | View analysis & find opportunities |
|
||||
|
||||
## Flow
|
||||
|
||||
1. **Landing** (`/`) - Marketing page with CTA
|
||||
2. **Onboarding** (`/onboarding`) - Input URL, AI analyzes website
|
||||
3. **Dashboard** (`/dashboard`) - Sidebar layout with analysis table + opportunities
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Set `OPENAI_API_KEY` in `.env` file.
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
app/
|
||||
├── page.tsx # Landing page
|
||||
├── layout.tsx # Root layout
|
||||
├── globals.css # Dark mode styles
|
||||
├── (app)/ # App group (with sidebar)
|
||||
│ ├── layout.tsx # App layout with sidebar
|
||||
│ ├── onboarding/
|
||||
│ │ └── page.tsx # URL input & analysis
|
||||
│ └── dashboard/
|
||||
│ └── page.tsx # Analysis display
|
||||
├── api/
|
||||
│ ├── analyze/route.ts # Scrape & analyze
|
||||
│ └── search/route.ts # Find opportunities
|
||||
components/
|
||||
├── sidebar.tsx # App sidebar navigation
|
||||
└── ui/ # shadcn components
|
||||
lib/
|
||||
├── scraper.ts # Puppeteer scraping
|
||||
├── openai.ts # AI analysis
|
||||
└── types.ts # TypeScript types
|
||||
```
|
||||
Reference in New Issue
Block a user