|
1 | 1 | > [!IMPORTANT] |
2 | 2 | > Twig is pre-alpha and not production-ready. Interested? Email jonathan@posthog.com |
3 | 3 |
|
| 4 | +**[Download the latest desktop app release](https://github.com/PostHog/twig/releases/latest)** |
4 | 5 |
|
5 | | -# PostHog Twig Monorepo |
| 6 | +# Twig |
6 | 7 |
|
7 | 8 | This is the monorepo for PostHog's Twig apps and the agent framework that powers them. |
8 | 9 |
|
9 | | -## Projects |
10 | | - |
11 | | -- **[apps/twig](./apps/twig)** - Twig desktop application (Electron) |
12 | | -- **[apps/mobile](./apps/mobile)** - PostHog mobile app (React Native / Expo) |
13 | | -- **[packages/agent](./packages/agent)** - The TypeScript agent framework |
14 | | - |
15 | | -## Documentation |
16 | | - |
17 | | -| File | Description | |
18 | | -|------|-------------| |
19 | | -| [README.md](./README.md) | Monorepo overview, setup, and troubleshooting | |
20 | | -| [CLAUDE.md](./CLAUDE.md) | Code style, patterns, and testing guidelines | |
21 | | -| [UPDATES.md](./UPDATES.md) | Release versioning and git tagging | |
22 | | -| [apps/twig/README.md](./apps/twig/README.md) | Desktop app: building, signing, distribution and workspace configuration | |
23 | | -| [apps/twig/ARCHITECTURE.md](./apps/twig/ARCHITECTURE.md) | Desktop app: dependency injection, tRPC, state management and events | |
24 | | -| [apps/mobile/README.md](./apps/mobile/README.md) | Mobile app: Expo setup, EAS builds and TestFlight deployment | |
25 | | -| [apps/cli/README.md](./apps/cli/README.md) | CLI app: Stacked PR management with Jujutsu | |
26 | | - |
27 | 10 | ## Development |
28 | 11 |
|
29 | 12 | ### Prerequisites |
@@ -67,16 +50,28 @@ Scripts in `scripts/` for development and debugging: |
67 | 50 | ## Project Structure |
68 | 51 |
|
69 | 52 | ``` |
70 | | -twig-monorepo/ |
| 53 | +twig/ |
71 | 54 | ├── apps/ |
72 | | -│ ├── twig/ # Electron desktop app |
73 | | -│ └── mobile/ # React Native mobile app (Expo) |
| 55 | +│ ├── twig/ # Electron desktop app (React, Vite) |
| 56 | +│ ├── mobile/ # React Native mobile app (Expo) |
| 57 | +│ └── cli/ # arr CLI for stacked PRs |
74 | 58 | ├── packages/ |
75 | | -│ └── agent/ # Agent framework |
76 | | -├── pnpm-workspace.yaml # Workspace configuration |
77 | | -└── package.json # Root package.json |
| 59 | +│ ├── agent/ # TypeScript agent framework |
| 60 | +│ ├── core/ # Shared business logic |
| 61 | +│ └── electron-trpc/ # tRPC for Electron IPC |
78 | 62 | ``` |
79 | 63 |
|
| 64 | +## Documentation |
| 65 | + |
| 66 | +| File | Description | |
| 67 | +|------|-------------| |
| 68 | +| [CLAUDE.md](./CLAUDE.md) | Code style, patterns, and testing guidelines | |
| 69 | +| [UPDATES.md](./UPDATES.md) | Release versioning and git tagging | |
| 70 | +| [apps/twig/README.md](./apps/twig/README.md) | Desktop app: building, signing, distribution, and workspace configuration | |
| 71 | +| [apps/twig/ARCHITECTURE.md](./apps/twig/ARCHITECTURE.md) | Desktop app: dependency injection, tRPC, state management, and events | |
| 72 | +| [apps/mobile/README.md](./apps/mobile/README.md) | Mobile app: Expo setup, EAS builds, and TestFlight deployment | |
| 73 | +| [apps/cli/README.md](./apps/cli/README.md) | CLI: stacked PR management with Jujutsu | |
| 74 | + |
80 | 75 | ## Troubleshooting |
81 | 76 |
|
82 | 77 | ### Electron failed to install correctly |
|
0 commit comments