Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 8 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,51 +21,25 @@ We use the Kaggle dataset [Better Recipes for a Better Life](https://www.kaggle.

## Status

First delivery. The client shows three hardcoded recipes from the dataset in a list, and each recipe opens on its own page. No backend or database yet.
2 delivery. Fully working backend with graphql interface

Planned stack: React + TypeScript with Vite, GraphQL backend on Node, database on the group VM.

python script seed sqlite database then graphql interface the DB to client

## Running the client

Requirements: Node.js 24.6 or newer and npm 11 or newer (see `engines` in `package.json`).

```bash
git clone https://git.ntnu.no/IT2810-H26/T30-Project-2.git
cd T30-Project-2
cd T30-Project-2/client
npm install
npm run dev
```

Open the localhost address printed in the terminal. Other useful commands:

| Command | What it does |
| ------------------- | ------------------------------------ |
| `npm run dev` | Start the dev server with hot reload |
| `npm run build` | Type check and build to `dist/` |
| `npm run preview` | Serve the last build locally |
| `npm run test` | Run the Vitest test suite |
| `npm run lint-full` | Lint the whole project with ESLint |
| `npm run format` | Format the project with Prettier |

Prettier and ESLint also run automatically on staged files when you commit (husky + lint-staged).

## Working in this repository

`main` is protected — you cannot push to it directly. Work on a branch and
open a pull request:

```bash
git checkout -b my-feature
git push -u origin my-feature
cd T30-Project-2/server
npm install
npm run dev
```

Before a pull request can be merged:

1. **A member of IT2810-H26-T30 must approve it.** You cannot approve your own pull
request, and approvals from staff do not count — you review each other's
code.
2. **Every review comment must be marked resolved.** Reply to each one, fix it
or explain why not, then click _Resolve conversation_.
3. **Pushing new commits dismisses the approval**, so if you change something
after being approved, ask for another review. This is deliberate: what was
approved is what gets merged.
Prettier and ESLint also run automatically on staged files when you commit (husky + lint-staged).
Loading