Expand README with step-by-step install and run, and the clickable localhost link

This commit is contained in:
2026-10-19 16:47:54 -06:00
parent 2e00ade0a2
commit c773547651
+37 -5
View File
@@ -42,25 +42,57 @@ restrictions. See `CLAUDE.md` and `docs/` (if present) for the design notes.
- Node.js 20 or newer (built and tested on Node 22).
- A Minnect account (your own email and password).
## Quickstart
## Install and run
You need **Node.js 20 or newer** (`node -v` to check) and your own Minnect
account.
**1. Get the code**
```bash
git clone <this-repo-url> minnect-feed-browser
cd minnect-feed-browser
```
**2. Install the dependencies**
```bash
npm install
```
**3. Start the app**
```bash
npm run dev
```
Open <http://localhost:3000>, sign in with your own Minnect email and password,
and you are in. A wrong password shows a single generic message and signs no one
in.
**4. Open it in your browser.** When it's ready, the terminal prints a local
link:
For a production-style local run instead of dev mode:
```
▲ Next.js 15.5.28
- Local: http://localhost:3000
```
👉 **Click that link — http://localhost:3000** — most terminals make it
clickable (Cmd-click on macOS, Ctrl-click on Windows/Linux). If it isn't
clickable, copy and paste it into your browser.
**5. Sign in** with your own Minnect email and password. That's it — you're in
the feed. (A wrong password just shows one generic message and signs no one in.)
To stop the app, press `Ctrl+C` in the terminal.
### Production-style run (optional)
To build once and run the optimized build instead of dev mode:
```bash
npm run build && npm start
```
Then open the same link: **http://localhost:3000**.
## Configuration
No configuration is required — the Minnect host URLs have sensible defaults. To