# idea-forge

**Repository Path**: carloz/idea-forge

## Basic Information

- **Project Name**: idea-forge
- **Description**: 一款 AI 驱动的商业计划分析与评估平台，让每一个想法都获得被成功验证的机会。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-28
- **Last Updated**: 2025-08-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# IdeaForge - AI-Powered Business Plan Generator

Transform your ideas into comprehensive business plans with AI assistance.

## 🚀 Quick Start

### Prerequisites

- Node.js 18+ 
- npm 9+
- PostgreSQL (Neon recommended)
- Redis (Upstash recommended)

### Installation

1. **Clone the repository**
   ```bash
   git clone https://github.com/your-username/idea-forge.git
   cd idea-forge
   ```

2. **Install dependencies**
   ```bash
   npm install
   ```

3. **Set up environment variables**
   ```bash
   cp env.example .env.local
   # Edit .env.local with your configuration
   ```

4. **Start development server**
   ```bash
   npm run dev
   ```

5. **Open your browser**
   Navigate to [http://localhost:3000](http://localhost:3000)

## 📁 Project Structure

```
idea-forge/
├── apps/
│   └── web/                 # Next.js web application
│       ├── src/
│       │   ├── app/         # App Router pages
│       │   ├── components/  # React components
│       │   ├── lib/         # Utilities and helpers
│       │   └── types/       # TypeScript types
│       ├── messages/        # i18n message files
│       └── public/          # Static assets
├── packages/
│   ├── ui/                  # Shared UI components
│   ├── config/              # Shared configuration
│   └── database/            # Database schema and operations
├── design-repo/             # Design documents and specifications
└── docs/                    # Documentation
```

## 🛠️ Development

### Available Scripts

- `npm run dev` - Start development server
- `npm run build` - Build for production
- `npm run lint` - Run ESLint
- `npm run type-check` - Run TypeScript type checking
- `npm run test` - Run tests
- `npm run clean` - Clean build artifacts

### Monorepo Commands

- `npm run dev` - Start all packages in development mode
- `npm run build` - Build all packages
- `npm run lint` - Lint all packages
- `npm run type-check` - Type check all packages

## 🌐 Internationalization

The application supports English (en) and Chinese (zh) languages.

- Default language: English
- URL structure: `/en` and `/zh`
- Message files: `apps/web/messages/`

## 🗄️ Database

### Setup

1. **Create database**
   ```sql
   CREATE DATABASE ideaforge;
   ```

2. **Run migrations**
   ```bash
   cd packages/database
   npm run db:generate
   npm run db:migrate
   ```

3. **View database (optional)**
   ```bash
   npm run db:studio
   ```

### Schema

The database includes the following main tables:

- `users` - User accounts and profiles
- `projects` - User projects
- `intakes` - Information collection forms
- `reports` - Generated business plans
- `plans` - Subscription plans
- `subscriptions` - User subscriptions
- `usage` - Usage tracking
- `assets` - Files and documents
- `blog_posts` - Blog content

## 🔧 Configuration

### Environment Variables

Required environment variables:

```bash
# Database
DATABASE_URL=postgresql://...

# Redis
REDIS_URL=redis://...

# Auth
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=your-secret-key

# Storage
CLOUDFLARE_R2_ACCESS_KEY=your-key
CLOUDFLARE_R2_SECRET_KEY=your-secret
CLOUDFLARE_R2_BUCKET=your-bucket

# Monitoring
SENTRY_DSN=your-sentry-dsn
```

### Feature Flags

- `ENABLE_ANALYTICS` - Enable analytics tracking
- `ENABLE_BLOG` - Enable blog functionality

## 🚀 Deployment

### Vercel (Recommended)

1. **Connect repository to Vercel**
2. **Set environment variables**
3. **Deploy automatically on push to main**

### Manual Deployment

1. **Build the application**
   ```bash
   npm run build
   ```

2. **Start production server**
   ```bash
   npm start
   ```

## 📊 Monitoring

### Sentry Integration

Error tracking and performance monitoring via Sentry.

### Health Checks

- Database connectivity: `/api/health/db`
- Redis connectivity: `/api/health/redis`
- Storage connectivity: `/api/health/storage`

## 🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

### Development Guidelines

- Follow TypeScript strict mode
- Use ESLint and Prettier
- Write unit tests for new features
- Update documentation as needed

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🆘 Support

- Documentation: [docs/](docs/)
- Issues: [GitHub Issues](https://github.com/your-username/idea-forge/issues)
- Discussions: [GitHub Discussions](https://github.com/your-username/idea-forge/discussions)

## 🗺️ Roadmap

See [design-repo/Roadmap.md](design-repo/Roadmap.md) for detailed development phases.

### Phase 0: Infrastructure ✅
- [x] Monorepo setup
- [x] Next.js with App Router
- [x] Internationalization
- [x] Database schema
- [x] CI/CD pipeline
- [x] Monitoring setup

### Phase 1: Information Collection MVP
- [ ] Multi-step form
- [ ] Data validation
- [ ] Draft saving
- [ ] Conversation clarification

### Phase 2: Report Generation Core
- [ ] AI integration
- [ ] Report generation
- [ ] Version management
- [ ] Export functionality

### Phase 3: Analysis Modules
- [ ] Business model analysis
- [ ] Market research
- [ ] SWOT analysis
- [ ] Financial projections

### Phase 4: Export & Sharing
- [ ] PDF export
- [ ] Share links
- [ ] Asset management

### Phase 5: Monetization
- [ ] Subscription plans
- [ ] Payment integration
- [ ] Usage tracking

### Phase 6: Beta & Launch
- [ ] User onboarding
- [ ] Analytics
- [ ] Performance optimization