Skip to content

Latest commit

 

History

History
55 lines (30 loc) · 1.38 KB

README.md

File metadata and controls

55 lines (30 loc) · 1.38 KB
Raw

Kenmerkende aspecten

Kenmerkende aspecten (short for ka) are history breakthroughs that all dutch highschool history students need to learn.

This website aims to making that learning process less painfull, while being accessible for the blind.

usage

  1. go to ka.pruijs.net
  2. Read the instructions on the website.

Contributing

Do you have ideas or seen a bug? You can create an issue. Check if your idea or bug report is not a duplicate.

Set up developer environment.

ka works with nix.

  1. run nix develop.
nix develop

This will install typescript version that is used with this project and typescript-lsp.

  1. go to ./site/ts and run:
tsc

This will compile typescript to javascript on save.

  1. Run local server to test it.

I use live server vsc plugin. But you can use whatever you like :)

open a pr

Before opening a pr, make sure you sign your commits. And run the folling command in the root of the repo:

nix build

This is same build process that runs at github. If there are now errors locally, it will probably succeed at github.

Thank you for contributing :D