diff --git a/README.md b/README.md new file mode 100644 index 00000000..d23a9d80 --- /dev/null +++ b/README.md @@ -0,0 +1,108 @@ +# Automaker + +Automaker is an autonomous AI development studio that helps you build software faster using AI-powered agents. It provides a visual Kanban board interface to manage features, automatically assigns AI agents to implement them, and tracks progress through an intuitive workflow from backlog to verified completion. + +--- + +> **[!CAUTION]** +> +> ## Security Disclaimer +> +> **This software uses AI-powered tooling that has access to your operating system and can read, modify, and delete files. Use at your own risk.** +> +> We have reviewed this codebase for security vulnerabilities, but you assume all risk when running this software. You should review the code yourself before running it. +> +> **We do not recommend running Automaker directly on your local computer** due to the risk of AI agents having access to your entire file system. Please sandbox this application using Docker or a virtual machine. +> +> **[Read the full disclaimer](../DISCLAIMER.md)** + +--- + +## Getting Started + +**Step 1:** Clone this repository: + +```bash +git clone git@github.com:AutoMaker-Org/automaker.git +cd automaker +``` + +**Step 2:** Install dependencies: + +```bash +npm install +``` + +**Step 3:** Run the Claude Code setup token command: + +```bash +claude setup-token +``` + +> **โš ๏ธ Warning:** This command will print your token to your terminal. Be careful if you're streaming or sharing your screen, as the token will be visible to anyone watching. + +**Step 4:** Export the Claude Code OAuth token in your shell: + +```bash +export CLAUDE_CODE_OAUTH_TOKEN="your-token-here" +``` + +**Step 5:** Start the development server: + +```bash +npm run dev:electron +``` + +This will start both the Next.js development server and the Electron application. + +**Step 6:** MOST IMPORANT: Run the Following after all is setup + +```bash +echo "W" +echo "W" +echo "W" +echo "W" +echo "W" +echo "W" +echo "W" +echo "W" +``` + +## Features + +- ๐Ÿ“‹ **Kanban Board** - Visual drag-and-drop board to manage features through backlog, in progress, waiting approval, and verified stages +- ๐Ÿค– **AI Agent Integration** - Automatic AI agent assignment to implement features when moved to "In Progress" +- ๐Ÿง  **Multi-Model Support** - Choose from multiple AI models including Claude Opus, Sonnet, and more +- ๐Ÿ’ญ **Extended Thinking** - Enable extended thinking modes for complex problem-solving +- ๐Ÿ“ก **Real-time Agent Output** - View live agent output, logs, and file diffs as features are being implemented +- ๐Ÿ” **Project Analysis** - AI-powered project structure analysis to understand your codebase +- ๐Ÿ“ **Context Management** - Add context files to help AI agents understand your project better +- ๐Ÿ’ก **Feature Suggestions** - AI-generated feature suggestions based on your project +- ๐Ÿ–ผ๏ธ **Image Support** - Attach images and screenshots to feature descriptions +- โšก **Concurrent Processing** - Configure concurrency to process multiple features simultaneously +- ๐Ÿงช **Test Integration** - Automatic test running and verification for implemented features +- ๐Ÿ”€ **Git Integration** - View git diffs and track changes made by AI agents +- ๐Ÿ‘ค **AI Profiles** - Create and manage different AI agent profiles for various tasks +- ๐Ÿ’ฌ **Chat History** - Keep track of conversations and interactions with AI agents +- โŒจ๏ธ **Keyboard Shortcuts** - Efficient navigation and actions via keyboard shortcuts +- ๐ŸŽจ **Dark/Light Theme** - Beautiful UI with theme support +- ๐Ÿ–ฅ๏ธ **Cross-Platform** - Desktop application built with Electron for Windows, macOS, and Linux + +## Tech Stack + +- [Next.js](https://nextjs.org) - React framework +- [Electron](https://www.electronjs.org/) - Desktop application framework +- [Tailwind CSS](https://tailwindcss.com/) - Styling +- [Zustand](https://zustand-demo.pmnd.rs/) - State management +- [dnd-kit](https://dndkit.com/) - Drag and drop functionality + +## Learn More + +To learn more about Next.js, take a look at the following resources: + +- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. +- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. + +## License + +See [LICENSE](../LICENSE) for details.