oo ii aa ii

Author: 9x14S

.github/workflows/deploy.yml

@@ -0,0 +1,55 @@
+name: Deploy to EC2
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Export deployment settings
+        run: |
+          echo "EC2_HOST=${{ secrets.EC2_HOST }}" >> "$GITHUB_ENV"
+          echo "EC2_USER=${{ secrets.EC2_USER }}" >> "$GITHUB_ENV"
+          if [ -n "${{ vars.DEPLOY_PORT }}" ]; then
+            echo "PORT=${{ vars.DEPLOY_PORT }}" >> "$GITHUB_ENV"
+          else
+            echo "PORT=80" >> "$GITHUB_ENV"
+          fi
+
+      - name: Set up SSH key
+        uses: webfactory/ssh-agent@v0.8.0
+        with:
+          ssh-private-key: ${{ secrets.EC2_SSH_KEY }}
+
+      - name: Add EC2 host to known_hosts
+        run: |
+          mkdir -p ~/.ssh
+          ssh-keyscan -H "$EC2_HOST" >> ~/.ssh/known_hosts
+
+      - name: Sync project to EC2
+        run: |
+          rsync -az --delete \
+            --exclude '.git' \
+            --exclude '.github' \
+            --exclude '.venv' \
+            --exclude '__pycache__' \
+            --exclude '*.pyc' \
+            --exclude '.ruff_cache' \
+            ./ "$EC2_USER@$EC2_HOST:/home/$EC2_USER/nasa-sky-app"
+
+      - name: Execute remote deployment
+        run: |
+          ssh "$EC2_USER@$EC2_HOST" "
+            set -euo pipefail
+            cd ~/nasa-sky-app
+            chmod +x deploy/deploy.sh
+            APP_ROOT=/opt/nasa-sky-app SERVICE_NAME=nasa-sky-app PORT=${PORT:-80} ./deploy/deploy.sh
+          "

.gitignore

@@ -1,3 +1,3 @@
 src/__pycache__/
 .venv/
-outputs
+.ruff_cache

README.md

@@ -20,6 +20,16 @@ A barebones FastAPI project that serves the landing page for the NASA Sky Explor
 
 3. Open <http://127.0.0.1:8000/> in your browser to view the page titled **“Minimal FastAPI App.”**
 
+## Linting
+
+Install Ruff into your virtual environment and run it against the project source to keep the
+codebase clean:
+
+```bash
+pip install ruff
+ruff check .
+```
+
 ## Project structure
 
 ```
@@ -30,6 +40,36 @@ NASASpaceAppsChallenge2025/
 │   └── server.py         # FastAPI application serving the HTML page
 └── web/
     └── index.html        # Static HTML served at the root route
+└── deploy/
+   └── deploy.sh         # Helper script to install and run the service via systemd
 ```
 
 Feel free to build on this foundation for richer APIs or interfaces.
+
+## Deployment script
+
+The `deploy/deploy.sh` script provisions the application on a Linux host using `systemd`. It:
+
+- Syncs the repository into `/opt/nasa-sky-app/app` (configurable with `APP_ROOT`).
+- Ensures `/opt/nasa-sky-app` exists with the proper ownership, then syncs code and creates a
+   virtual environment for dependencies.
+- Generates a `systemd` unit that runs Uvicorn on port `80` by default.
+- Enables and restarts the service.
+
+Run it directly on the target server after cloning or syncing the repository:
+
+```bash
+chmod +x deploy/deploy.sh
+APP_ROOT=/opt/nasa-sky-app SERVICE_NAME=nasa-sky-app ./deploy/deploy.sh
+```
+
+Override `SERVICE_USER`, `SERVICE_GROUP`, `PORT`, or `PYTHON_BIN` to fit your environment. When the
+port is below `1024` (the default `80`), the generated unit grants
+`CAP_NET_BIND_SERVICE` so the application can bind to the port without running as root.
+
+### GitHub Actions deployment
+
+A workflow at `.github/workflows/deploy.yml` uses the repository secrets `EC2_HOST`, `EC2_USER`,
+and `EC2_SSH_KEY` to sync the codebase to an Ubuntu 24.04 EC2 instance and execute the deployment
+script remotely. It runs on every push to `main` (and can be triggered manually). Optional
+repository variable `DEPLOY_PORT` lets you override the port without editing the workflow.

deploy/deploy.sh

@@ -0,0 +1,107 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+APP_ROOT=${APP_ROOT:-/opt/nasa-sky-app}
+APP_DIR="${APP_ROOT}/app"
+VENV_DIR="${APP_ROOT}/venv"
+SERVICE_NAME=${SERVICE_NAME:-nasa-sky-app}
+PORT=${PORT:-80}
+PYTHON_BIN=${PYTHON_BIN:-python3}
+SUDO_BIN=${SUDO_BIN:-sudo}
+export DEBIAN_FRONTEND=${DEBIAN_FRONTEND:-noninteractive}
+
+SERVICE_USER=${SERVICE_USER:-$(whoami)}
+SERVICE_GROUP=${SERVICE_GROUP:-$(id -gn)}
+
+if [ "${PORT}" -lt 1024 ]; then
+  echo "Deploying service on privileged port ${PORT}."
+fi
+
+SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
+REPO_ROOT=$(cd "${SCRIPT_DIR}/.." && pwd)
+
+if command -v apt-get >/dev/null 2>&1; then
+  if ! command -v rsync >/dev/null 2>&1; then
+    echo "Installing rsync via apt-get"
+    ${SUDO_BIN} apt-get update -y
+    ${SUDO_BIN} apt-get install -y rsync
+  fi
+
+  if ! command -v "${PYTHON_BIN}" >/dev/null 2>&1; then
+    echo "Installing Python via apt-get"
+    ${SUDO_BIN} apt-get update -y
+    ${SUDO_BIN} apt-get install -y python3 python3-venv python3-pip
+  else
+    if ! "${PYTHON_BIN}" -m venv --help >/dev/null 2>&1; then
+      echo "Installing python3-venv via apt-get"
+      ${SUDO_BIN} apt-get update -y
+      ${SUDO_BIN} apt-get install -y python3-venv
+    fi
+    if ! command -v pip3 >/dev/null 2>&1; then
+      echo "Installing python3-pip via apt-get"
+      ${SUDO_BIN} apt-get update -y
+      ${SUDO_BIN} apt-get install -y python3-pip
+    fi
+  fi
+fi
+
+if ! command -v rsync >/dev/null 2>&1; then
+  echo "rsync is required but was not found in PATH" >&2
+  exit 1
+fi
+
+if ! command -v "${PYTHON_BIN}" >/dev/null 2>&1; then
+  echo "Python interpreter '${PYTHON_BIN}' not found" >&2
+  exit 1
+fi
+
+if [ ! -d "${APP_ROOT}" ]; then
+  ${SUDO_BIN} mkdir -p "${APP_ROOT}"
+fi
+${SUDO_BIN} mkdir -p "${APP_DIR}" "${VENV_DIR}"
+${SUDO_BIN} chown -R "${SERVICE_USER}:${SERVICE_GROUP}" "${APP_ROOT}"
+
+rsync -a --delete \
+  --exclude ".git" \
+  --exclude ".venv" \
+  --exclude "__pycache__" \
+  --exclude "*.pyc" \
+  --exclude ".ruff_cache" \
+  "${REPO_ROOT}/" "${APP_DIR}/"
+
+"${PYTHON_BIN}" -m venv "${VENV_DIR}"
+"${VENV_DIR}/bin/pip" install --upgrade pip
+"${VENV_DIR}/bin/pip" install -r "${APP_DIR}/requirements.txt"
+
+SERVICE_FILE="/etc/systemd/system/${SERVICE_NAME}.service"
+
+CAPABILITY_LINES=""
+if [ "${PORT}" -lt 1024 ]; then
+  CAPABILITY_LINES=$'AmbientCapabilities=CAP_NET_BIND_SERVICE\nCapabilityBoundingSet=CAP_NET_BIND_SERVICE'
+fi
+
+read -r -d '' SERVICE_UNIT <<EOF
+[Unit]
+Description=NASA Sky Explorer FastAPI Service
+After=network.target
+
+[Service]
+User=${SERVICE_USER}
+Group=${SERVICE_GROUP}
+WorkingDirectory=${APP_DIR}
+Environment="PATH=${VENV_DIR}/bin"
+ExecStart=${VENV_DIR}/bin/uvicorn src.server:app --host 0.0.0.0 --port ${PORT}
+Restart=on-failure
+${CAPABILITY_LINES}
+
+[Install]
+WantedBy=multi-user.target
+EOF
+
+${SUDO_BIN} tee "${SERVICE_FILE}" >/dev/null <<<"${SERVICE_UNIT}"
+${SUDO_BIN} systemctl daemon-reload
+${SUDO_BIN} systemctl enable --now "${SERVICE_NAME}.service"
+${SUDO_BIN} systemctl restart "${SERVICE_NAME}.service"
+
+${SUDO_BIN} systemctl status "${SERVICE_NAME}.service" --no-pager

ruff.toml

@@ -0,0 +1,6 @@
+line-length = 120
+src = ["src"]
+target-version = "py312"
+
+[lint]
+select = ["E", "F", "I", "UP", "W"]

src/server.py

@@ -1,4 +1,4 @@
-"""Minimal FastAPI application that serves a static HTML homepage for the NASA Sky Explorer Prototype."""
+"""Minimal FastAPI application that serves the NASA Sky Explorer Prototype website."""
 
 from pathlib import Path
 
@@ -8,24 +8,27 @@
 BASE_DIR = Path(__file__).resolve().parent.parent
 WEB_DIR = BASE_DIR / "web"
 INDEX_PATH = WEB_DIR / "index.html"
+ALADIN_PATH = WEB_DIR / "aladin.html"
 
 app = FastAPI(title="NASA Sky Explorer Prototype")
 
 
+def _read_html(path: Path) -> str:
+    if not path.exists():
+        raise HTTPException(status_code=404, detail=f"{path.name} not found")
+    return path.read_text(encoding="utf-8")
+
+
 @app.get("/", response_class=HTMLResponse)
 def read_index() -> str:
     """Return the contents of the bundled ``index.html`` file."""
 
 
 @app.get("/aladin")
 async def aladin() -> FileResponse:
+    """Serve the Aladin viewer page."""
     return FileResponse("web/aladin.html")
 
-
-@app.get("/")
-async def root() -> JSONResponse:
-    return JSONResponse({"status": "ok", "message": "Visit /app for the prototype UI."})
-
 if __name__ == "__main__":
     import uvicorn