|
4 | 4 |
|
5 | 5 |  |
6 | 6 |
|
7 | | -<!-- TOP_VERSION_BADGE --> |
8 | | -[](https://github.com/AndyMik90/Auto-Claude/releases/tag/v2.7.2) |
9 | | -<!-- TOP_VERSION_BADGE_END --> |
10 | 7 | [](./agpl-3.0.txt) |
11 | 8 | [](https://discord.gg/KCXaPBr4Dj) |
| 9 | +[](https://www.youtube.com/@AndreMikalsen) |
12 | 10 | [](https://github.com/AndyMik90/Auto-Claude/actions) |
13 | 11 |
|
14 | 12 | --- |
|
59 | 57 | - **Claude Pro/Max subscription** - [Get one here](https://claude.ai/upgrade) |
60 | 58 | - **Claude Code CLI** - `npm install -g @anthropic-ai/claude-code` |
61 | 59 | - **Git repository** - Your project must be initialized as a git repo |
62 | | -- **Python 3.12+** - Required for the backend and Memory Layer |
63 | 60 |
|
64 | 61 | --- |
65 | 62 |
|
@@ -148,113 +145,11 @@ See [guides/CLI-USAGE.md](guides/CLI-USAGE.md) for complete CLI documentation. |
148 | 145 |
|
149 | 146 | --- |
150 | 147 |
|
151 | | -## Configuration |
| 148 | +## Development |
152 | 149 |
|
153 | | -Create `apps/backend/.env` from the example: |
| 150 | +Want to build from source or contribute? See [CONTRIBUTING.md](CONTRIBUTING.md) for complete development setup instructions. |
154 | 151 |
|
155 | | -```bash |
156 | | -cp apps/backend/.env.example apps/backend/.env |
157 | | -``` |
158 | | - |
159 | | -| Variable | Required | Description | |
160 | | -|----------|----------|-------------| |
161 | | -| `CLAUDE_CODE_OAUTH_TOKEN` | Yes | OAuth token from `claude setup-token` | |
162 | | -| `GRAPHITI_ENABLED` | No | Enable Memory Layer for cross-session context | |
163 | | -| `AUTO_BUILD_MODEL` | No | Override the default Claude model | |
164 | | -| `GITLAB_TOKEN` | No | GitLab Personal Access Token for GitLab integration | |
165 | | -| `GITLAB_INSTANCE_URL` | No | GitLab instance URL (defaults to gitlab.com) | |
166 | | -| `LINEAR_API_KEY` | No | Linear API key for task sync | |
167 | | - |
168 | | ---- |
169 | | - |
170 | | -## Building from Source |
171 | | - |
172 | | -For contributors and development: |
173 | | - |
174 | | -```bash |
175 | | -# Clone the repository |
176 | | -git clone https://github.com/AndyMik90/Auto-Claude.git |
177 | | -cd Auto-Claude |
178 | | - |
179 | | -# Install all dependencies |
180 | | -npm run install:all |
181 | | - |
182 | | -# Run in development mode |
183 | | -npm run dev |
184 | | - |
185 | | -# Or build and run |
186 | | -npm start |
187 | | -``` |
188 | | - |
189 | | -**System requirements for building:** |
190 | | -- Node.js 24+ |
191 | | -- Python 3.12+ |
192 | | -- npm 10+ |
193 | | - |
194 | | -**Installing dependencies by platform:** |
195 | | - |
196 | | -<details> |
197 | | -<summary><b>Windows</b></summary> |
198 | | - |
199 | | -```bash |
200 | | -winget install Python.Python.3.12 |
201 | | -winget install OpenJS.NodeJS.LTS |
202 | | -``` |
203 | | - |
204 | | -</details> |
205 | | - |
206 | | -<details> |
207 | | -<summary><b>macOS</b></summary> |
208 | | - |
209 | | -```bash |
210 | | -brew install python@3.12 node@24 |
211 | | -``` |
212 | | - |
213 | | -</details> |
214 | | - |
215 | | -<details> |
216 | | -<summary><b>Linux (Ubuntu/Debian)</b></summary> |
217 | | - |
218 | | -```bash |
219 | | -sudo apt install python3.12 python3.12-venv |
220 | | -curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash - |
221 | | -sudo apt install -y nodejs |
222 | | -``` |
223 | | - |
224 | | -</details> |
225 | | - |
226 | | -<details> |
227 | | -<summary><b>Linux (Fedora)</b></summary> |
228 | | - |
229 | | -```bash |
230 | | -sudo dnf install python3.12 nodejs npm |
231 | | -``` |
232 | | - |
233 | | -</details> |
234 | | - |
235 | | -See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed development setup. |
236 | | - |
237 | | -### Building Flatpak |
238 | | - |
239 | | -To build the Flatpak package, you need additional dependencies: |
240 | | - |
241 | | -```bash |
242 | | -# Fedora/RHEL |
243 | | -sudo dnf install flatpak-builder |
244 | | - |
245 | | -# Ubuntu/Debian |
246 | | -sudo apt install flatpak-builder |
247 | | - |
248 | | -# Install required Flatpak runtimes |
249 | | -flatpak install flathub org.freedesktop.Platform//25.08 org.freedesktop.Sdk//25.08 |
250 | | -flatpak install flathub org.electronjs.Electron2.BaseApp//25.08 |
251 | | - |
252 | | -# Build the Flatpak |
253 | | -cd apps/frontend |
254 | | -npm run package:flatpak |
255 | | -``` |
256 | | - |
257 | | -The Flatpak will be created in `apps/frontend/dist/`. |
| 152 | +For Linux-specific builds (Flatpak, AppImage), see [guides/linux.md](guides/linux.md). |
258 | 153 |
|
259 | 154 | --- |
260 | 155 |
|
@@ -284,7 +179,7 @@ All releases are: |
284 | 179 | | `npm run package:mac` | Package for macOS | |
285 | 180 | | `npm run package:win` | Package for Windows | |
286 | 181 | | `npm run package:linux` | Package for Linux | |
287 | | -| `npm run package:flatpak` | Package as Flatpak | |
| 182 | +| `npm run package:flatpak` | Package as Flatpak (see [guides/linux.md](guides/linux.md)) | |
288 | 183 | | `npm run lint` | Run linter | |
289 | 184 | | `npm test` | Run frontend tests | |
290 | 185 | | `npm run test:backend` | Run backend tests | |
@@ -316,3 +211,11 @@ We welcome contributions! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for: |
316 | 211 | Auto Claude is free to use. If you modify and distribute it, or run it as a service, your code must also be open source under AGPL-3.0. |
317 | 212 |
|
318 | 213 | Commercial licensing available for closed-source use cases. |
| 214 | + |
| 215 | +--- |
| 216 | + |
| 217 | +## Star History |
| 218 | + |
| 219 | +[](https://github.com/AndyMik90/Auto-Claude/stargazers) |
| 220 | + |
| 221 | +[](https://star-history.com/#AndyMik90/Auto-Claude&Date) |
0 commit comments