Skip to content
This repository has been archived by the owner on Nov 9, 2022. It is now read-only.

Latest commit

 

History

History
58 lines (42 loc) · 1.7 KB

README.dev.md

File metadata and controls

58 lines (42 loc) · 1.7 KB
Raw

Developer documentation

Tech stack

  1. Vue 3
  2. Vite
  3. Vitest
  4. TypeScript

IDE / dev setup

We recommend using Volar VSCode extension for improved development experience. The project uses Vue 3 <script setup> SFCs, check out the script setup docs to learn more.

  1. VS Code
  2. Volar

Development installation

cd <some dir>
git clone https://github.com/ardc-fair-checklist/spa .
npm install

Building for development:

npm run dev

Building for production:

npm run build

Publishing

There is a GitHub action /.github/workflows/publish.yml that builds the project for production and hosts it at https://ardc-fair-checklist.github.io/spa. The GitHub action can be triggered manually via the GitHub user interface.

TODO

  1. add points to questions
  2. show points in interface for the time being
  3. calculate partial and total progress
  4. write jsonschema for questions
  5. add rst badge
  6. make questions part of the store and settable, derive other variables and make them gettable
  7. publish coverage in ci
  8. add testing as prose
  9. implement testing prose
  10. write foundation for versioning of list of questions
  11. add validation of query parameters
  12. use the checklist for a couple of existing software packages
  13. revisit questions content with TomH
  14. investigate migrating to SSRSSG Prerendering
  15. investigate using tailwindcss for styling