Skip to content

feat: add examples front page #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Many0nne merged 3 commits into from
Apr 25, 2026
Merged

feat: add examples front page #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eaba41a
feat: add examples front page
Many0nne Apr 14, 2026
15e1dbf
fix: sonarqube errors
Many0nne Apr 25, 2026
68f5805
fix: reduce cognitive reflexion
Many0nne Apr 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,36 @@ Write a TypeScript interface, get a fully working REST API with realistic mock d

---

## 🖥️ Try the Demo

The repo includes a ready-to-use demo with sample types and a frontend UI.

**1 — Install dependencies** (first time only)

```bash
npm install
```

**2 — Start the server**

```bash
npm start
```

This uses `.mock-config.json` at the root, which points to `demo/types/` on port `3000`.

**3 — Open the frontend**

Open `demo/index.html` directly in your browser (no server needed for the UI itself):

```
demo/index.html ← open this file in your browser
```

Then click **Connect** — the UI will automatically discover the available types (`User`, `Product`, `Order`) and let you browse, filter, create, edit, and delete mock data.

---

## ⚡ Quick Start

### 1 — Install
Expand Down
Loading
Loading