mirror of
https://github.com/temporal-community/temporal-ai-agent.git
synced 2026-03-15 14:08:08 +01:00
setup readme
This commit is contained in:
27
setup.md
27
setup.md
@@ -93,10 +93,32 @@ temporal server start-dev
|
|||||||
```
|
```
|
||||||
See the [Temporal documentation](https://learn.temporal.io/getting_started/python/dev_environment/) for other platforms.
|
See the [Temporal documentation](https://learn.temporal.io/getting_started/python/dev_environment/) for other platforms.
|
||||||
|
|
||||||
|
You can also run a local Temporal server using Docker Compose. See the `Development with Docker` section below.
|
||||||
|
|
||||||
## Running the Application
|
## Running the Application
|
||||||
|
|
||||||
### Python Backend
|
### Docker
|
||||||
|
- All services are defined in `docker-compose.yml` (includes a Temporal server).
|
||||||
|
- **Dev overrides** (mounted code, live‑reload commands) live in `docker-compose.override.yml` and are **auto‑merged** on `docker compose up`.
|
||||||
|
- To start **development** mode (with hot‑reload):
|
||||||
|
```bash
|
||||||
|
docker compose up -d
|
||||||
|
# quick rebuild without infra:
|
||||||
|
docker compose up -d --no-deps --build api train-api worker frontend
|
||||||
|
```
|
||||||
|
- To run **production** mode (ignore dev overrides):
|
||||||
|
```bash
|
||||||
|
docker compose -f docker-compose.yml up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
Default urls:
|
||||||
|
* Temporal UI: [http://localhost:8080](http://localhost:8080)
|
||||||
|
* API: [http://localhost:8000](http://localhost:8000)
|
||||||
|
* Frontend: [http://localhost:5173](http://localhost:5173)
|
||||||
|
|
||||||
|
### Local Machine (no docker)
|
||||||
|
|
||||||
|
**Python Backend**
|
||||||
|
|
||||||
Requires [Poetry](https://python-poetry.org/) to manage dependencies.
|
Requires [Poetry](https://python-poetry.org/) to manage dependencies.
|
||||||
|
|
||||||
@@ -119,7 +141,7 @@ poetry run uvicorn api.main:app --reload
|
|||||||
```
|
```
|
||||||
Access the API at `/docs` to see the available endpoints.
|
Access the API at `/docs` to see the available endpoints.
|
||||||
|
|
||||||
### React UI
|
**React UI**
|
||||||
Start the frontend:
|
Start the frontend:
|
||||||
```bash
|
```bash
|
||||||
cd frontend
|
cd frontend
|
||||||
@@ -129,7 +151,6 @@ npx vite
|
|||||||
Access the UI at `http://localhost:5173`
|
Access the UI at `http://localhost:5173`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Goal-Specific Tool Configuration
|
## Goal-Specific Tool Configuration
|
||||||
Here is configuration guidance for specific goals. Travel and financial goals have configuration & setup as below.
|
Here is configuration guidance for specific goals. Travel and financial goals have configuration & setup as below.
|
||||||
### Goal: Find an event in Australia / New Zealand, book flights to it and invoice the user for the cost
|
### Goal: Find an event in Australia / New Zealand, book flights to it and invoice the user for the cost
|
||||||
|
|||||||
Reference in New Issue
Block a user