Visit the live website at summarywebsitetemplate.internal.hippodigital.cloud.
- checkout the project
git clone [email protected]:hippo-digital/engineering-data-handbook.git
-
install Node.js 18
a. check your current version of Node.js
node --version
b. If you have the wrong version or Node.js is not installed
Download it from the Node.js website or use nvm (recommended)
nvm use
-
install all required packages
npm install
- run the development server:
npm run dev
- open http://localhost:3000 with your browser to see the result.
- create a
.env.local
file with following variables:
GOOGLE_CLIENT_ID=insert the client id
GOOGLE_SECRET=insert the secret
Ask @colin for the secrets that are needed.
- make sure this file isn't committed.
- restart the server.
- open http://localhost:3000 with your browser to see the result.
Tests will run as a pre-commit hook, when creating new Pull Requests, and when code is merged into the main branch.
To run tests locally:
npm test
Playwright is used for end-to-end testing which opens a browser and navigates like a user.
You'll need to download the Playwright specific dependencies with:
npx playwright install --with-deps chromium
In order to run the Playwright tests in a visual mode (so you can see what they're actually doing), just run:
npm run test:open
Linting will also run as a pre-commit hook, when creating new Pull Requests, and when code is merged into the main branch.
To run linting locally:
npm run lint
To auto-fix any auto-fixable linting issues, run:
npm run lint:fix