Heatwise is a project to visualise spatial-temporal heat demand across England and Wales, as gathered by The Centre for Integrated Renewable Energy Generation and Supply (CIREGS) at Cardiff University's School of Engineering. Details on how this data was gathered is available in the research paper
Our wiki is kept upto date with essential onboarding information and important links
Please see the onboarding page on our wiki
To run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun devNext.js will host the dev server at http://localhost:3000
We deploy Heatwise to Vercel. Details on best practice for this is available here. If you wish to deploy elsewhere:
-
Ensure Node.js is installed and the project is cloned.
-
Run the build script once, which builds the production application in the .next folder
npm run build
-
After building, the start script starts a Node.js server that supports hybrid pages, serving both statically generated and server-side rendered pages, and API Routes
npm run start
We use Playwright for testing our frontend and api endpoints. All tests are located in the /tests folder and are run on every commit via our GitLab CICD
To run tests locally, first install playwright dependencies and build the project:
npm run build
npx playwright installAnd then run the tests. Playwright will automatically run the build server and genereate a HTML report once completed:
npx playwright testOptional: When writing new tests, playwright's UI mode has better debugging tools:
npx playwright test --ui