CONTRIBUTING.md

Contributing

Right now there aren't any specific requests or recommendations for contributing, but if you're interested in getting involved or have questions, feel free to open up a new topic in the Runrig Discussions board. You can also view the roadmap and kanban where we're chiefly managing the project collectively.

This first pilot is implemented as a single-page application (SPA) that can be deployed to any CDN service, such as those provided by Vercel, Netlify or Cloudflare. Refer to your hosting service for primary documentation on how to configure and deploy, but you'll mainly just need to set it up to install the required NPM packages via npm install, then by running the build script, npm run build.

Below are the original instructions that were generated via create-vue.

Recommended IDE Setup

VSCode + Volar (and disable Vetur).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need Volar to make the TypeScript language service aware of .vue types.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Lint with ESLint

npm run lint