Getting Started

Getting Started

Requirements

• Node.js 20 (the version the deploy workflow uses)
• npm (the repository ships a package-lock.json)

Install and run

git clone https://github.com/stackified/RestroFX.git
cd RestroFX
git checkout dev
npm ci          # installs every workspace from the root
npm run dev     # http://localhost:3000/

The root dev, build and start scripts forward to the apps/web workspace.

Checks

npm run lint --workspace=apps/web          # next lint (next/core-web-vitals)
npm run type-check --workspace=apps/web    # tsc --noEmit
npm run build                              # next build, static export

Run lint and type-check against apps/web. The root scripts of the same name run in every workspace, and some packages (for example packages/config) do not define them.

Previewing a production build

next.config.js sets output: 'export', so npm run build writes a fully static site to apps/web/out. npm start (next start) is not supported with a static export. Serve the folder with any static server instead:

npx serve apps/web/out

To reproduce the GitHub Pages build, which is served under /RestroFX, pass the same variables the workflow uses:

BASE_PATH=/RestroFX NEXT_PUBLIC_BASE_PATH=/RestroFX ASSET_PREFIX=/RestroFX/ npm run build

Fonts

Fonts are loaded with next/font/google: Archivo for headings, Inter for body text and Poppins for numbers. SETUP.md explains how to swap Inter for General Sans if a license is available.

Environment variables

There is no .env file to create. The only variables are the three build-time base path settings above, which CI sets automatically.