These instructions will help you setup the development tools necessary to make changes to the source code and test them quickly.
You need to install:
- VS Code
- The VS Code Vue - Official (Volar) extension
- nvm (Node Version Manager)
- pnpm
After cloning the repository, install and activate the correct Node.js version using nvm, then install dependencies:
nvm install
nvm use
pnpm installThe repository includes an .nvmrc file that pins the required Node.js version.
A Google Cloud Platform API key is required to access data from Google Sheets. To prevent targeted attacks, no API key is part of the source code. For development, create a file named api.key in the repository root directory and make this API key the content of that file:
AIzaSyA0HixV4dH5WdpOdFOSPfCbQLnmOTJvkXM
This API key only works, when the application is run on localhost:5173. This is the default while developing.
You can also create your own key by following the instructions in BUILD.md.
Open the terminal inside VS Code using the View → Terminal action from the menu bar.
Starts the application in development mode. Navigate to http://localhost:5173 to see the application running. Changes to the source code will be injected live into the running application. No manual reloads are required.
Runs all eslint code checks.
Builds the application. Output is available in the dist folder.
The Vue devtools browser extension can be used to view a lot of the internals of dldu-points.
To open the Vue devtools, open the default browser devtools with F12 and select the new Vue tab on the right.