Update CLAUDE.md with dev environment and git workflow preferences
This commit is contained in:
parent
3588139201
commit
4018503723
1 changed files with 13 additions and 6 deletions
|
|
@ -8,14 +8,20 @@ A real estate listing crawler and aggregator that scrapes property listings from
|
|||
|
||||
## Development Environment
|
||||
|
||||
**IMPORTANT**: This project runs on a remote host, not locally. Always use the remote executor to run commands:
|
||||
**All project commands run inside Docker containers.** Start the dev environment with Docker Compose, then exec into containers:
|
||||
|
||||
- **All shell commands** (Python, pytest, poetry, alembic, etc.) must be executed via the remote executor
|
||||
- **Starting the project**: Use the remote executor to run `./start.sh`
|
||||
- **Running tests**: Use the remote executor to run `pytest`
|
||||
- **Any CLI operations**: Use the remote executor to run `python main.py ...`
|
||||
- **Start dev environment**: `docker compose up -d` (locally)
|
||||
- **Building/pushing images**: `docker build` / `docker push` (locally)
|
||||
- **Deploying to K8s**: `kubectl` (locally, context: `kubernetes-admin@kubernetes`)
|
||||
- **Running tests**: `docker compose exec app pytest tests/ -v`
|
||||
- **CLI operations**: `docker compose exec app python main.py ...`
|
||||
- **Migrations**: `docker compose exec app alembic upgrade head`
|
||||
- **Type check**: `docker compose exec app mypy .`
|
||||
- **Linting**: `docker compose exec app ruff check .`
|
||||
|
||||
Never run commands directly on the local machine - always route them through the remote executor.
|
||||
Always ensure containers are running (`docker compose up -d`) before executing commands.
|
||||
|
||||
See `.claude/skills/` for detailed skills on dev environment, building, and deploying.
|
||||
|
||||
## Commands
|
||||
|
||||
|
|
@ -230,4 +236,5 @@ The project uses strict mypy configuration with `disallow_untyped_defs=true`. Ru
|
|||
- Do not include unrelated files
|
||||
- Use descriptive commit messages
|
||||
- Group related files together (e.g., tests with the code they test)
|
||||
- **After each meaningful change, ask the user if they want to commit and push the changes**
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue