Skip to content

Commit ff70f9c

Browse files
Simplify README and add Makefile targets for dev and setup-infra
1 parent 6127b0d commit ff70f9c

2 files changed

Lines changed: 15 additions & 35 deletions

File tree

Makefile

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: check fmt test clean deps setup-hooks
1+
.PHONY: check fmt test clean deps setup-hooks dev setup-infra
22

33
check:
44
uv run ruff check .
@@ -20,3 +20,9 @@ setup-hooks:
2020
cp scripts/githooks/pre-commit .git/hooks/pre-commit
2121
chmod +x .git/hooks/pre-commit
2222
@echo "Git hooks installed."
23+
24+
dev:
25+
./scripts/dev.sh
26+
27+
setup-infra:
28+
./scripts/setup_infra.sh $(PROJECT_ID)

README.md

Lines changed: 8 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<a href="https://github.com/oadultradeepfield/gemini-live-agent-challenge-backend/stargazers">
1313
<img src="https://img.shields.io/github/stars/oadultradeepfield/gemini-live-agent-challenge-backend" alt="stars" />
1414
</a>
15-
<a href="https://github.com/oadultradeepfield/gemini-live-agent-challenge-backend/blob/main/LICENSE">
15+
<a href="LICENSE">
1616
<img src="https://img.shields.io/github/license/oadultradeepfield/gemini-live-agent-challenge-backend.svg" alt="license" />
1717
</a>
1818
</p>
@@ -151,13 +151,7 @@ To run this project, create a `.env` file based on `.env.example`:
151151

152152
### Prerequisites
153153

154-
This project uses `uv` for package management:
155-
156-
```bash
157-
curl -LsSf https://astral.sh/uv/install.sh | sh
158-
```
159-
160-
Docker is optional for containerized development.
154+
This project uses `uv` for package management. See the [Makefile](Makefile) for available commands.
161155

162156
### Installation
163157

@@ -168,41 +162,21 @@ git clone https://github.com/oadultradeepfield/gemini-live-agent-challenge-backe
168162
cd gemini-live-agent-challenge-backend
169163
```
170164

171-
2. Set up environment variables:
172-
173-
```bash
174-
# For local development with API key
175-
export GOOGLE_API_KEY=your-api-key-here
176-
export GOOGLE_GENAI_USE_VERTEXAI=FALSE
177-
```
165+
2. Set up environment variables from `.env.example`
178166

179167
3. Run the development server:
180168

181169
```bash
182-
./scripts/dev.sh
183-
```
184-
185-
Or with Docker Compose:
186-
187-
```bash
188-
docker compose up --build
170+
make dev
189171
```
190172

191173
The WebSocket endpoint will be available at `ws://localhost:8080/ws/{device_id}`.
192174

193175
### Running Tests
194176

195177
```bash
196-
# Run linting and type checks
197-
make check
198-
199-
# Run test suite
200-
make test
201-
202-
# Run integration tests (requires Firestore emulator)
203-
gcloud emulators firestore start --host-port=localhost:8081 &
204-
export FIRESTORE_EMULATOR_HOST=localhost:8081
205-
make test
178+
make check # Run linting and type checks
179+
make test # Run test suite
206180
```
207181

208182
## Deployment
@@ -212,7 +186,7 @@ make test
212186
Run the setup script to create required GCP resources:
213187

214188
```bash
215-
./scripts/setup_infra.sh your-project-id
189+
make setup-infra PROJECT_ID=your-project-id
216190
```
217191

218192
This creates:
@@ -235,4 +209,4 @@ This creates:
235209

236210
## License
237211

238-
Distributed under the MIT License. See `LICENSE` for more information.
212+
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.

0 commit comments

Comments
 (0)