🚀 AutoProject

AutoProject is your ultimate Bring Your Own Keys (BYOK) tool to automate product and project management with AI-powered workflows.
Run locally, in production, or securely in Docker — your choice.

🌟 Key Features

• Generative PRD Creation: Feed your requirements and receive tailor-made PRDs.
• AI-Powered User Story Generation: Convert PRDs into smart, structured user stories.
• Tool Integration: Instantly push stories into Linear, Asana, Jira, or Plane.

🛠️ Tech Stack

Built with ⚡ Bun for fast runtime performance.

🚀 Getting Started (Development Mode)

Prerequisites

• Bun (latest version)
• Docker Desktop (for Docker option)
• API Keys:
  • Linear API Key — Create here
  • Gemini API Key — Create here
  • Groq API Key — Create here

1. Local Development Setup

Clone and install dependencies:

git clone https://github.com/aditya-xq/AutoProject.git
cd AutoProject/autoproject
bun install

Create your .env file:

cp .env.example .env
# Edit .env and add your real API keys

Run the app in development mode:

bun run dev

Access the app at http://localhost:5173.

🔥 Running in Production Mode

Build the app:

bun run build

Preview the production build:

bun run preview

Default preview port: 4173.
Access it at http://localhost:4173.

🐳 Running with Docker

1. Using Docker Compose (Recommended)

Prepare your .env file:

cp .env.example .env
# Fill in your API keys

Use the provided docker-compose.yml or create one like this:

services:
  autoproject:
    image: xqbuilds/autoproject:latest
    ports:
      - "3000:3000"
    env_file:
      - .env
    environment:
      NODE_ENV: production
    restart: unless-stopped

Run:

docker-compose up -d

Access the app at http://localhost:3000.

2. Running Manually Without Compose

docker run --env-file .env -p 3000:3000 xqbuilds/autoproject:latest

📜 Environment Variables

Important:

🚨 No secrets are included inside the public Docker image. All sensitive information must be provided by the user at runtime.

🙌 Contributing

Contributions are welcome! Feel free to fork, clone, and submit PRs.

💬 Feedback

Connect on Twitter @xq_is_here and share your feedback!

📄 License

Licensed under the MIT License.