typefaster-cli 0.1.2__tar.gz → 0.1.4__tar.gz

{typefaster_cli-0.1.2 → typefaster_cli-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: typefaster-cli
-Version: 0.1.2
+Version: 0.1.4
 Summary: A terminal-first typing game inspired by MonkeyType and TypeRacer.
 Project-URL: Homepage, https://github.com/Anoshor/typefaster-cli
 Project-URL: Repository, https://github.com/Anoshor/typefaster-cli
@@ -47,6 +47,18 @@ typefaster
 
 …and you're racing within seconds. No login, no server, no Docker, no internet required.
 
+## Install
+
+```bash
+# Homebrew
+brew install Anoshor/typefaster/typefaster
+
+# or pipx (any OS)
+pipx install typefaster-cli
+
+typefaster            # play
+```
+
 ---
 
 ## What Phase 1 delivers

{typefaster_cli-0.1.2 → typefaster_cli-0.1.4}/README.md

@@ -15,6 +15,18 @@ typefaster
 
 …and you're racing within seconds. No login, no server, no Docker, no internet required.
 
+## Install
+
+```bash
+# Homebrew
+brew install Anoshor/typefaster/typefaster
+
+# or pipx (any OS)
+pipx install typefaster-cli
+
+typefaster            # play
+```
+
 ---
 
 ## What Phase 1 delivers

{typefaster_cli-0.1.2 → typefaster_cli-0.1.4}/client/typefaster/__init__.py

@@ -1,3 +1,3 @@
 """TYPEFASTER-CLI — a terminal-first typing game."""
 
-__version__ = "0.1.2"
+__version__ = "0.1.4"

{typefaster_cli-0.1.2 → typefaster_cli-0.1.4}/client/typefaster/net/token_store.py

@@ -18,7 +18,7 @@ class Session:
     # Default points at the public TYPEFASTER server so a fresh install can
     # register/play with zero config. Override with `typefaster config set-server`
     # (e.g. a local server or your own deployment).
-    server_url: str = "https://typefaster-cli.fly.dev"
+    server_url: str = "http://140.245.248.113:8000"
     token: str | None = None
     username: str | None = None
 

{typefaster_cli-0.1.2 → typefaster_cli-0.1.4}/client/typefaster/ui/screens/online_race.py

@@ -307,11 +307,8 @@ class OnlineRaceScreen(Screen[None]):
 
     # ── exit ───────────────────────────────────────────────────────────
     def action_leave(self) -> None:
+        # This screen IS the whole online app, so leaving exits cleanly back to
+        # the shell (popping the only screen would leave a blank screen). The
+        # server removes us from the lobby when the WebSocket closes on exit.
         self.run_worker(self._send("LEAVE"), name="leave")
-        if self._ws is not None:
-            self.run_worker(self._close_ws(), name="close")
-        self.app.pop_screen()
-
-    async def _close_ws(self) -> None:
-        with contextlib.suppress(Exception):
-            await self._ws.close()
+        self.app.exit()

typefaster_cli-0.1.4/docs/INSTALL.md

@@ -0,0 +1,64 @@
+# Installing & playing TYPEFASTER
+
+A terminal typing game. Works offline instantly; multiplayer if you point it at
+a server.
+
+## Install
+
+**Homebrew (macOS / Linux):**
+```bash
+brew install Anoshor/typefaster/typefaster
+```
+
+**pipx (any OS with Python 3.11+):**
+```bash
+pipx install typefaster-cli
+```
+
+Verify:
+```bash
+typefaster version
+```
+
+## Play offline (no account, no internet)
+```bash
+typefaster                 # main menu — Quick Race, Time Attack, Practice, Daily…
+typefaster race            # jump straight into a quote race
+typefaster race --mode time --time 60
+typefaster stats           # your progress
+```
+
+## Play online (multiplayer)
+The client ships pointing at the public server by default, so:
+```bash
+typefaster register <name>           # create an account (password)
+# or social login:
+typefaster login --github
+typefaster login --google
+
+typefaster lobby create --name Friday --time 60   # host a lobby (shows a join code)
+typefaster lobby join ABC123                        # friends join with the code
+typefaster lobby list                               # browse public lobbies
+typefaster leaderboard global                       # global | daily | weekly
+```
+In the lobby waiting room, press **R** to ready; the server starts the race when
+everyone is ready. Press **Esc** to leave.
+
+Point at a different server (self-hosted / local):
+```bash
+typefaster config set-server https://your-server.example.com
+typefaster config show
+```
+
+## Update
+```bash
+brew upgrade typefaster          # Homebrew
+pipx upgrade typefaster-cli      # pipx
+```
+
+## Uninstall
+```bash
+brew uninstall typefaster
+# or
+pipx uninstall typefaster-cli
+```

typefaster_cli-0.1.4/docs/deploy-oracle.md

@@ -0,0 +1,89 @@
+# Deploy the server on an Oracle Cloud Always-Free VM ($0 forever)
+
+A real 24/7 server on Oracle's Always-Free ARM VM. No ongoing cost.
+
+You do the **console steps** (account + VM + open a port). Then a **single
+command** on the VM deploys everything (`scripts/deploy-oracle.sh`).
+
+---
+
+## 1. Create the account
+1. Go to <https://www.oracle.com/cloud/free/> → **Start for free**.
+2. Sign up. A credit/debit card is required for identity verification — Oracle
+   **does not charge** Always-Free resources. Pick your home region close to you
+   (you can't change it later).
+
+## 2. Create an Always-Free VM
+1. Console → **Menu → Compute → Instances → Create instance**.
+2. **Image & shape → Edit shape**:
+   - Shape series: **Ampere (Arm)** → `VM.Standard.A1.Flex`
+   - Set **1 OCPU / 6 GB** (well within the free allowance; plenty for this).
+   - *(If Ampere shows "out of capacity", try another availability domain, or use
+     the AMD `VM.Standard.E2.1.Micro` Always-Free shape instead.)*
+3. **Image**: Canonical **Ubuntu 22.04** (or 24.04).
+4. **Networking**: keep the default VCN; ensure **"Assign a public IPv4 address"** is on.
+5. **SSH keys**: choose **Generate a key pair** and **download the private key**
+   (or paste your own public key).
+6. **Create**. When it's running, copy the **Public IP address**.
+
+## 3. Open the game port (VCN Security List)
+Oracle blocks inbound by default — open TCP **8000**:
+1. Instance page → **Virtual cloud network** link → **Security Lists** →
+   **Default Security List**.
+2. **Add Ingress Rules**:
+   - Source CIDR: `0.0.0.0/0`
+   - IP Protocol: **TCP**
+   - Destination Port Range: `8000`
+   - **Add**.
+
+## 4. SSH in and deploy (one command)
+```bash
+chmod 400 ~/Downloads/your-key.key      # the key you downloaded
+ssh -i ~/Downloads/your-key.key ubuntu@<PUBLIC_IP>
+
+# on the VM:
+curl -fsSL https://raw.githubusercontent.com/Anoshor/typefaster-cli/main/scripts/deploy-oracle.sh | bash
+```
+The script installs Docker, builds the stack, opens the OS firewall, and prints:
+```
+Public: http://<PUBLIC_IP>:8000/healthz
+```
+Check it from your laptop:
+```bash
+curl http://<PUBLIC_IP>:8000/healthz     # {"status":"ok"}
+```
+
+## 5. Play
+```bash
+typefaster config set-server http://<PUBLIC_IP>:8000
+typefaster register <name>
+typefaster lobby create --name Friday --time 60
+```
+Multiplayer runs over `ws://` (works fine). Share the IP + `config set-server`
+line with friends.
+
+> Want the client to default to your server (so nobody needs `config set-server`)?
+> Tell me the public IP/domain and I'll bake it in and ship a new release.
+
+---
+
+## Optional: free HTTPS + stable hostname (DuckDNS + Caddy)
+Plain `http://IP` works, but for a tidy `https://you.duckdns.org`:
+1. Get a free subdomain at <https://www.duckdns.org> and point it at your VM IP.
+2. On the VM, run Caddy as a reverse proxy (auto Let's Encrypt):
+   ```bash
+   sudo docker run -d --name caddy --restart unless-stopped --network host \
+     caddy caddy reverse-proxy --from you.duckdns.org --to :8000
+   ```
+3. Open TCP **80** and **443** in the VCN Security List too.
+4. Players: `typefaster config set-server https://you.duckdns.org` (uses `wss://`).
+
+## Updating later
+```bash
+ssh -i key ubuntu@<IP> 'curl -fsSL https://raw.githubusercontent.com/Anoshor/typefaster-cli/main/scripts/deploy-oracle.sh | bash'
+```
+
+## Stop / costs
+Always-Free resources don't expire as long as the account stays in good standing.
+To stop: `sudo docker compose down` in `/opt/typefaster`. No charges for the
+Always-Free shapes.

{typefaster_cli-0.1.2 → typefaster_cli-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "typefaster-cli"
-version = "0.1.2"
+version = "0.1.4"
 description = "A terminal-first typing game inspired by MonkeyType and TypeRacer."
 readme = "README.md"
 requires-python = ">=3.11"

typefaster_cli-0.1.4/scripts/deploy-oracle.sh

@@ -0,0 +1,76 @@
+#!/usr/bin/env bash
+# One-shot TYPEFASTER server deploy for a fresh Ubuntu VM (Oracle Always-Free,
+# or any Ubuntu host). Installs Docker, fetches the repo, and starts the stack.
+#
+# Run it on the VM (as the default user, e.g. `ubuntu`):
+#   curl -fsSL https://raw.githubusercontent.com/Anoshor/typefaster-cli/main/scripts/deploy-oracle.sh | bash
+#
+# Re-running it safely updates to the latest code and restarts the stack.
+set -euo pipefail
+
+REPO="https://github.com/Anoshor/typefaster-cli"
+DIR="/opt/typefaster"
+PORT="${SERVER_PORT:-8000}"
+
+echo "==> Installing prerequisites (git, openssl, iptables-persistent)…"
+sudo apt-get update -y
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y git openssl ca-certificates curl
+
+echo "==> Installing Docker (if missing)…"
+if ! command -v docker >/dev/null 2>&1; then
+  curl -fsSL https://get.docker.com | sudo sh
+fi
+sudo systemctl enable --now docker
+
+echo "==> Fetching the repo into ${DIR}…"
+sudo mkdir -p "$DIR"
+sudo chown "$USER" "$DIR"
+if [ -d "$DIR/.git" ]; then
+  git -C "$DIR" pull --ff-only
+else
+  git clone "$REPO" "$DIR"
+fi
+cd "$DIR"
+
+echo "==> Writing .env (random JWT secret) if absent…"
+if [ ! -f .env ]; then
+  cat > .env <<EOF
+TYPEFASTER_JWT_SECRET=$(openssl rand -hex 32)
+TYPEFASTER_CORS_ORIGINS=*
+TYPEFASTER_ACCESS_TOKEN_MINUTES=1440
+SERVER_PORT=${PORT}
+EOF
+fi
+
+echo "==> Opening port ${PORT} on the OS firewall (Oracle Ubuntu blocks by default)…"
+# Oracle's Ubuntu images ship iptables rules that REJECT inbound. Insert ACCEPT.
+if sudo iptables -C INPUT -p tcp --dport "${PORT}" -j ACCEPT 2>/dev/null; then
+  echo "    (rule already present)"
+else
+  sudo iptables -I INPUT -p tcp --dport "${PORT}" -j ACCEPT
+fi
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y iptables-persistent >/dev/null 2>&1 || true
+sudo netfilter-persistent save >/dev/null 2>&1 || true
+
+echo "==> Building & starting the stack…"
+sudo docker compose up -d --build
+
+echo "==> Waiting for health…"
+for _ in $(seq 1 40); do
+  if curl -fsS "http://127.0.0.1:${PORT}/healthz" >/dev/null 2>&1; then break; fi
+  sleep 2
+done
+
+IP="$(curl -fsS ifconfig.me 2>/dev/null || echo '<this-vm-public-ip>')"
+echo
+echo "============================================================"
+echo " TYPEFASTER server is up."
+echo "   Local : http://127.0.0.1:${PORT}/healthz"
+echo "   Public: http://${IP}:${PORT}/healthz"
+echo
+echo " Players point their CLI at it with:"
+echo "   typefaster config set-server http://${IP}:${PORT}"
+echo
+echo " IMPORTANT: also add an Ingress rule for TCP ${PORT} (source 0.0.0.0/0)"
+echo " in your VCN Security List in the Oracle console, or it won't be reachable."
+echo "============================================================"