mirror of
https://github.com/AutoMaker-Org/automaker.git
synced 2026-02-04 09:13:08 +00:00
Merge pull request #40 from AutoMaker-Org/docs/update-readme-with-run-instructions
docs: add comprehensive run instructions and improve README formatting
This commit is contained in:
67
README.md
67
README.md
@@ -45,12 +45,77 @@ export CLAUDE_CODE_OAUTH_TOKEN="sk-ant-oat01-..."
|
|||||||
npm run dev:electron
|
npm run dev:electron
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## How to Run
|
||||||
|
|
||||||
|
### Development Modes
|
||||||
|
|
||||||
|
Automaker can be run in several modes:
|
||||||
|
|
||||||
|
#### Electron Desktop App (Recommended)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Standard development mode
|
||||||
|
npm run dev:electron
|
||||||
|
|
||||||
|
# With DevTools open automatically
|
||||||
|
npm run dev:electron:debug
|
||||||
|
|
||||||
|
# For WSL (Windows Subsystem for Linux)
|
||||||
|
npm run dev:electron:wsl
|
||||||
|
|
||||||
|
# For WSL with GPU acceleration
|
||||||
|
npm run dev:electron:wsl:gpu
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Web Browser Mode
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run in web browser (http://localhost:3007)
|
||||||
|
npm run dev:web
|
||||||
|
# or
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
### Building for Production
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Build Next.js app
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
# Build Electron app for distribution
|
||||||
|
npm run build:electron
|
||||||
|
```
|
||||||
|
|
||||||
|
### Running Production Build
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Start production Next.js server
|
||||||
|
npm run start
|
||||||
|
```
|
||||||
|
|
||||||
|
### Testing
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run tests headless
|
||||||
|
npm run test
|
||||||
|
|
||||||
|
# Run tests with browser visible
|
||||||
|
npm run test:headed
|
||||||
|
```
|
||||||
|
|
||||||
|
### Linting
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run ESLint
|
||||||
|
npm run lint
|
||||||
|
```
|
||||||
|
|
||||||
### Authentication Options
|
### Authentication Options
|
||||||
|
|
||||||
Automaker supports multiple authentication methods (in order of priority):
|
Automaker supports multiple authentication methods (in order of priority):
|
||||||
|
|
||||||
| Method | Environment Variable | Description |
|
| Method | Environment Variable | Description |
|
||||||
|--------|---------------------|-------------|
|
| -------------------- | ------------------------- | --------------------------------------------------------- |
|
||||||
| OAuth Token (env) | `CLAUDE_CODE_OAUTH_TOKEN` | From `claude setup-token` - uses your Claude subscription |
|
| OAuth Token (env) | `CLAUDE_CODE_OAUTH_TOKEN` | From `claude setup-token` - uses your Claude subscription |
|
||||||
| OAuth Token (stored) | — | Stored in app credentials file |
|
| OAuth Token (stored) | — | Stored in app credentials file |
|
||||||
| API Key (stored) | — | Anthropic API key stored in app |
|
| API Key (stored) | — | Anthropic API key stored in app |
|
||||||
|
|||||||
Reference in New Issue
Block a user