Development

This website is built with Vite and Vue. npm is the primary package manager; just is optional to simplify common commands.

Prerequisites

• Node.js (v18 or higher)
• npm
• Optional: just (for simplified commands)

Getting Started

First, install the dependencies:

npm install

Then, you can use just to run the common commands:

• just dev: Run the development server
• just build: Build for production
• just preview: Preview the production build locally

Don't have `just`? Use npm

• npm run dev: Run the development server
• npm run build: Build for production
• npm run preview: Preview the production build locally
• npm run lint: Lint the project
• npm run lint:fix: Lint and fix all possible errors
• npm run typecheck: Typechecks the project with vue-tsc

Formatting

The project utilizes the @antfu/eslint-config to standardize formatting. This means that we solely utilize ESLint to lint and format the project.

Since the @antfu/eslint-config doesn't support formatting for CSS files, we have to utilize an external formatter (in this case prettier) under eslint-plugin-format to actually format the files.

Please ensure that you format your code before submitting a PR!

Contributing

If you want to add another language to this website, add a json file to src/locales with your language file named following Navigator.language and it should be good to go!

Your new language will follow the schema from enUS, so make sure the fields and everything are the same. Some fields may contain markdown support or HTML support, that really depends and there is just no way I can document this here.