D3-App-Template

A template for an interactive web application with D3

BSD-3-CLAUSE License

Stars
8
Committers
1

D3-App-Template

A template for an interactive web application with D3.

Launch the app

Install node and then install the dependencies.

npm install

Then you can run the app.

npm run dev

This launches the app in developer mode. To run the app in production mode, run npm run build or see below.

Code style

We recommed using VSCode for development. You can run npm run lint to check for linting errors. Note that these tests automatically run when you comit your code to GitHub. See test.yml for details. You can fix a lot of issues autoamtically with npm run format. If you see TypeScript errors that you don't want to fix, you can silence them with a comment // @ts-ignore.

Deployment

When you push to GitHub, the app automatically deploys to GitHub Pages. As an example, this template repository is deployed at domoritz.github.io/D3-App-Template. See deploy.yml for details. Make sure to update the base property in vite.config.ts to match your repo name.

Notes

Related Projects