Installation

Installation

Prerequisites

Tool	Minimum version	Notes
Node.js	20	The CI pipeline uses Node 22; both work locally
npm	10	Bundled with Node 20+ — no separate install needed
Git	any	For cloning the repository
A modern browser	—	Chrome, Edge, Firefox, or Safari

Docker users: Docker and Docker Compose are only needed if you want to run the pre-built container instead of the Node dev setup. See Deployment → Docker.

---

Step 1 — Clone the repository

git clone git@github.com:NesiciCoding/RubricMaker.git
cd RubricMaker

Or clone over HTTPS if you haven't set up SSH keys:

git clone https://github.com/NesiciCoding/RubricMaker.git
cd RubricMaker

---

Step 2 — Install dependencies

npm install

This installs all runtime and development dependencies listed in package.json. The first run takes 1–2 minutes; subsequent runs are faster due to the npm cache.

---

Step 3 — Start the development server

npm run dev

Open http://localhost:5173 in your browser. The app loads instantly with hot-module replacement — edit a file and the browser updates without a full reload.

---

Verifying the install

If the dev server starts and the app opens in the browser, you're good. To double-check the full toolchain:

npm run typecheck   # TypeScript type-check (no output = all good)
npm run lint        # ESLint
npm run test        # Run the test suite

All three should complete without errors on a clean install.

---

Troubleshooting

npm install fails with peer dependency errors

Make sure you are on Node 20 or later:

node --version   # should print v20.x.x or higher

If you have multiple Node versions installed, use nvm or fnm to switch:

nvm use 20
# or
fnm use 20

Port 5173 is already in use

Either stop the other process or start Vite on a different port:

npm run dev -- --port 5174

Browser shows a blank page

Open the browser's developer console (F12). A missing module error usually means npm install didn't complete successfully — delete node_modules/ and run it again:

rm -rf node_modules
npm install