Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 8 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,21 +151,15 @@ pixi run pre-commit-install

### Running the ETL Pipeline

````bash
```bash
# Create environment file from template
cp resources/docker/.env.example resources/docker/.env

<<<<<<< docs-improvement
```bash
# 1. Start all services (PostgreSQL, Prefect server, worker)
=======
# Start all services (PostgreSQL, Prefect server, worker)
>>>>>>> main
pixi run start-services

# Deploy and run ETL flows
# 2. Deploy ETL flows
pixi run deploy
<<<<<<< docs-improvement

# 3. Apply any pending database migrations
# Note: start-services automatically applies migrations at startup via the
Expand All @@ -180,12 +174,7 @@ pixi run run-etl

# Stop services
pixi run teardown-services
=======
pixi run run-etl

# Monitor via Prefect UI at http://localhost:4200
>>>>>>> main
````
```

### Running the Web Service

Expand All @@ -208,18 +197,15 @@ pixi run -e docs docs-serve

## Contributing

See [`docs/CONTRIBUTING.md`](docs/CONTRIBUTING.md) for general contribution
guidelines (branching, PRs, commit style, pre-commit setup).
See [CONTRIBUTING.md](CONTRIBUTING.md) for general contribution guidelines
(branching, PRs, commit style, pre-commit setup).

Each namespace package also has its own contributing guide with
component-specific details:

- [`docs/datamodels/CONTRIBUTING.md`](docs/datamodels/CONTRIBUTING.md) -- Data
models and database schema
- [`docs/pipeline/CONTRIBUTING.md`](docs/pipeline/CONTRIBUTING.md) -- ETL
pipeline and Prefect workflows
- [`docs/webservice/CONTRIBUTING.md`](docs/webservice/CONTRIBUTING.md) --
FastAPI web service
- [Datamodels](datamodels/CONTRIBUTING.md): Data models and database schema
- [Pipeline](pipeline/CONTRIBUTING.md): ETL pipeline and Prefect workflows
- [Webservice](webservice/CONTRIBUTING.md): FastAPI web service

## Acknowledgement

Expand Down
1 change: 1 addition & 0 deletions datamodels
1 change: 1 addition & 0 deletions docs/LICENSE
1 change: 1 addition & 0 deletions docs/SECURITY.md
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,5 @@ nav:
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Code of Conduct: CODE_OF_CONDUCT.md
- ERD View: ERD_VIEW.md
- Security: SECURITY.md
- License: LICENSE
1 change: 1 addition & 0 deletions pipeline
1 change: 1 addition & 0 deletions webservice
Loading