|
1 |
| -# Run Restack Desktop |
| 1 | +# Restack Examples for Typescript |
2 | 2 |
|
3 |
| -Open restack-desktop.dmg and launch app |
| 3 | +Restack is an open source framework for building autonomous AI applications in TypeScript. It helps developers build resilient, autonomous AI workflows that can execute logic and API calls reliably, maintain state over weeks or months, and self-improve over time. The examples in this repository demonstrate how to build TypeScript applications using Restack's features. |
4 | 4 |
|
5 |
| -Restack Engine will run locally in the application |
| 5 | +## Quick Start |
6 | 6 |
|
7 |
| -# Alternative run Restack in Docker |
| 7 | +Start the Restack Engine and Web UI using Docker: |
8 | 8 |
|
| 9 | +``` |
9 | 10 | docker run -d --pull always --name studio -p 5233:5233 -p 6233:6233 -p 7233:7233 ghcr.io/restackio/engine:main
|
| 11 | +``` |
10 | 12 |
|
11 |
| -or |
| 13 | +Or using Docker Compose: |
12 | 14 |
|
| 15 | +``` |
13 | 16 | docker compose up -d --build --pull always
|
| 17 | +``` |
14 | 18 |
|
15 |
| -(will force repulling and rebuilding) |
| 19 | +The Restack Web UI will be available at http://localhost:5233 |
16 | 20 |
|
17 |
| -Restack Desktop UI will be available at http://localhost:5233 |
| 21 | +## Examples |
| 22 | + |
| 23 | +### Autonomous AI Examples |
| 24 | + |
| 25 | +- [examples/posthog](examples/posthog) - Analyzes PostHog session recordings and creates Linear digests |
| 26 | + |
| 27 | + |
| 28 | +[Find more autonomous examples](https://docs.restack.io/examples) |
| 29 | + |
| 30 | +### AI Integration Examples |
| 31 | + |
| 32 | +- [examples/openai](examples/openai) - Basic OpenAI integration example |
| 33 | +- [examples/gemini](examples/gemini) - Example using Google's Gemini model |
| 34 | +- [examples/voice](examples/voice) - Voice processing with Deepgram and OpenAI |
| 35 | +- [examples/composio](examples/composio) - Calendar event creation with AI |
| 36 | + |
| 37 | +### Framework Examples |
| 38 | + |
| 39 | +- [examples/get-started](examples/get-started) - Basic starter template |
| 40 | +- [examples/nextjs](examples/nextjs) - Integration with Next.js applications |
| 41 | +- [examples/human-loop](examples/human-loop) - Example of human-in-the-loop workflows |
| 42 | + |
| 43 | +## Documentation |
| 44 | + |
| 45 | +For detailed documentation and guides, visit [https://docs.restack.io/](https://docs.restack.io/) |
| 46 | + |
| 47 | +Join our community on [Discord](https://discord.com/invite/79JuDTNEQm) for support and discussions. |
| 48 | + |
| 49 | +## Local Restack Components |
| 50 | + |
| 51 | +### Restack Engine |
| 52 | + |
| 53 | +The Restack Engine uses Temporal to reliably run and manage AI workflows. It handles all the complex orchestration behind the scenes, including: |
| 54 | + |
| 55 | +- Long-running workflows that maintain state for days or months |
| 56 | +- Detailed workflow replay and debugging |
| 57 | +- Automated event processing and handling |
| 58 | +- Scheduled and recurring job execution |
| 59 | +- Smart API rate limiting |
| 60 | +- Persistent memory and state management |
| 61 | + |
| 62 | +### Restack Web Interface |
| 63 | + |
| 64 | +The web-based dashboard lets you: |
| 65 | + |
| 66 | +- Track and troubleshoot running workflows |
| 67 | +- Step through and replay workflow executions |
| 68 | +- Test and validate individual functions |
| 69 | +- Create and manage workflow schedules |
| 70 | +- Access complete execution logs and history |
0 commit comments