Add workflow for github actions

Author: EugeneSim

.github/workflows/publish-quarto.yml

@@ -0,0 +1,57 @@
+name: Publish Quarto to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "pip"
+          cache-dependency-path: "pyproject.toml"
+
+      - name: Install Python package
+        working-directory: .
+        run: |
+          python -m pip install -e .
+
+      - name: Setup Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: "1.6.40"
+
+      - name: Render Quarto
+        working-directory: quarto
+        run: quarto render
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: quarto/_site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deploy
+        uses: actions/deploy-pages@v4

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Test
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "pip"
+          cache-dependency-path: "pyproject.toml"
+      - name: Install
+        run: |
+          python -m pip install -e ".[dev]"
+      - name: Ruff
+        run: python -m ruff check src tests streamlit_app.py scripts pages
+      - name: Pytest
+        env:
+          SINGAPORE_EDA_HEALTH_SKIP_HTTP: "1"
+        run: python -m pytest tests -q

.gitignore

@@ -0,0 +1,47 @@
+# Data
+data/raw/*
+!data/raw/.gitkeep
+data/processed/*
+!data/processed/.gitkeep
+data/processed/.http_cache/
+**/.http_cache/
+data/reference/planning_areas.geojson
+
+# Python
+.venv/
+venv/
+__pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.pip-audit-cache/
+dist/
+build/
+*.egg-info/
+
+# Jupyter
+.ipynb_checkpoints/
+*.ipynb_checkpoints
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Quarto
+_site/
+quarto/_site/
+**/_quarto/
+.quarto/
+*.qmd~
+
+# Env
+.env
+.env.local

.streamlit/config.toml

@@ -0,0 +1,2 @@
+[browser]
+gatherUsageStats = false

.streamlit/secrets.toml.example

@@ -0,0 +1,4 @@
+# Copy to Streamlit Cloud "Secrets" (do not commit real keys)
+# DATA_GOV_SG_API_KEY = "your-key"
+# Optional: unlock Ops & Admin page in the Streamlit multipage app
+# SINGAPORE_EDA_ADMIN_TOKEN = "long-random-token"

LICENSE

@@ -0,0 +1,28 @@
+MIT License
+
+Copyright (c) 2026 Eugene Sim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Third-party materials in the `course_materials/` directory may be subject to
+their own licenses. The Jupyter tutorial folder includes a separate MIT
+license file where applicable. Original course notebook attributions and
+licenses (e.g. rmotr, freecodecamp materials) are preserved in that folder.

Makefile

@@ -0,0 +1,38 @@
+PYTHON ?= python3
+PIP ?= $(PYTHON) -m pip
+
+.PHONY: install test ruff app report web clean-data rent-data health-serve
+
+install:
+	$(PIP) install -e ".[dev]"
+
+test:
+	$(PYTHON) -m pytest tests -q
+
+ruff:
+	$(PYTHON) -m ruff check src tests streamlit_app.py scripts
+
+# Download full HDB dataset (slow: paginated API with throttling; optional max rows for dev)
+clean-data:
+	$(PYTHON) -m singapore_eda.download_data --output data/raw/hdb_resale_2017_onwards.csv
+
+# HDB median rent by town/flat (data.gov.sg); needed for yield tab
+rent-data:
+	$(PYTHON) -m singapore_eda.rent_ingest -o data/raw/median_rent_hdb.csv
+
+app:
+	$(PYTHON) -m streamlit run streamlit_app.py
+
+# Requires Quarto CLI: https://quarto.org/docs/get-started/
+report:
+	cd quarto && quarto render
+
+analysis:
+	$(PYTHON) scripts/run_analysis.py
+
+fetch-geo:
+	$(PYTHON) scripts/fetch_reference_geo.py
+
+# Optional: pip install -e ".[api]" — liveness/readiness + /metrics for operations
+health-serve:
+	$(PYTHON) -m singapore_eda.health_server