🚀 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, or self-host. It's your choice.

🌟 Key Features

• AI PRD Creation: Feed your requirements and receive tailor-made PRDs.
• AI User Story Generation: Convert PRDs into smart, structured user stories.
• Project View: Manage your user stories, copy their details for AI prompting.
• Tool Integration: Instantly push stories into Linear.
• Mutiple Inference Support: Choose from Gemini, Groq, LM Studio.
• Preset Modes: Specialized configurations for different use cases.

🐳 Running with Docker (Recommended for users)

1. Using Docker Compose (Recommended)

Ensure you have Docker Desktop installed and docker engine is running on your machine.

Prepare your .env file:

# PROJECT TOOLS API TOKENS
SECRET_LINEAR_API_KEY="Your linear api key"

# AI API TOKENS
SECRET_GEMINI_API_KEY="Your gemini api key"
SECRET_GROQ_API_KEY="Your groq api key"

# Local inference
INFERENCE_SERVER_URL=http://127.0.0.1:1234
INFERENCE_SERVER_URL_DOCKER=http://host.docker.internal:1234

Use the provided docker-compose.yml or create one like this in the same directory as your .env file:

services:
  autoproject:
    container_name: autoproject_app
    image: xqbuilds/autoproject:latest
    pull_policy: always
    ports:
      - "3000:3000"
    env_file:
      - .env
    environment:
      NODE_ENV: production
      DOCKER_ENV: true
    restart: unless-stopped

Run:

docker compose up -d

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

To stop the container, you can use:

docker compose stop

For a clean reset to remove the container and its data, you can use:

docker compose down

With this approach, you do not need to fork the repo and setup any development environment. All you need are the API keys, .env file, and the Docker Compose file.

🚀 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

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.

📜 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.