From d83eb86f2235debd85d5c8b31804bc4e2ad39439 Mon Sep 17 00:00:00 2001 From: Cody Seibert Date: Wed, 10 Dec 2025 13:23:58 -0500 Subject: [PATCH] docs: enhance README with detailed setup instructions and security warnings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Added a comprehensive "Getting Started" section with step-by-step instructions for cloning the repository, installing dependencies, and running the development server. - Included a warning about the visibility of the Claude Code setup token during streaming or screen sharing. - Maintained the existing security disclaimer while improving overall README structure for better clarity. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- app/README.md | 67 +++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 51 insertions(+), 16 deletions(-) diff --git a/app/README.md b/app/README.md index fc43a642..d23a9d80 100644 --- a/app/README.md +++ b/app/README.md @@ -5,6 +5,7 @@ Automaker is an autonomous AI development studio that helps you build software f --- > **[!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.** @@ -17,6 +18,56 @@ Automaker is an autonomous AI development studio that helps you build software f --- +## 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 @@ -37,22 +88,6 @@ Automaker is an autonomous AI development studio that helps you build software f - 🎨 **Dark/Light Theme** - Beautiful UI with theme support - 🖥️ **Cross-Platform** - Desktop application built with Electron for Windows, macOS, and Linux -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` - -Open [http://localhost:3007](http://localhost:3007) with your browser to see the result. - ## Tech Stack - [Next.js](https://nextjs.org) - React framework