From 6bd6c274a26b3c2d28866f042574acf4863fb172 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 2 Mar 2026 16:23:28 +0000 Subject: [PATCH 1/2] Initial plan From 2db8e4011be52831d5c5d33303d464e608afc3f6 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 2 Mar 2026 16:24:47 +0000 Subject: [PATCH 2/2] docs: add tech stack and dev/build/deploy instructions to README Co-authored-by: sheenyg <25390061+sheenyg@users.noreply.github.com> --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 146675f..1856444 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,49 @@ Wouldreads is currently at **version 1.1**. The app collects news articles from --- +## Tech stack + +| Layer | Technology | +|---|---| +| Language | TypeScript | +| UI framework | React 19 | +| Build tool | Vite (with `@vitejs/plugin-react-swc`) | +| Styling | Tailwind CSS v4 via `@tailwindcss/vite` | +| Component primitives | Radix UI | + +--- + +## Local development + +**Prerequisites:** Node.js LTS and npm. + +```bash +# Install dependencies (clean install from lockfile) +npm ci + +# Start the dev server (http://localhost:5173) +npm run dev + +# Lint the codebase +npm run lint +``` + +--- + +## Build & deploy + +```bash +# Compile TypeScript and bundle with Vite +npm run build + +# Preview the production build locally +npm run preview +``` + +**GitHub Pages note:** Vite is configured with `base: "/wouldreads/"` in `vite.config.ts` so that assets resolve correctly when deployed to `https://sheenyg.github.io/wouldreads/`. If you fork this repo or deploy to a different URL, update the `base` value to match your repository name or deploy path. + +--- + ## Contributing Feel free to **fork** this repository and create your own version of Wouldreads!