Skip to content

Latest commit

 

History

History
62 lines (36 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

62 lines (36 loc) · 1.76 KB

Contributing Guide

WIP

Thanks for your interest in contributing to this project. Before getting started, you might find this guideline useful.

 

Project Structure

This is a monorepo based on a pnpm workspace:

  • packages: Contains useful functions needed by this app
  • site: The main site

 

Development Setup

This app is deployed with Node.js version 20+ and pnpm version 9+.

It is built on Nuxt 3, with the power of Vue 3, Vite, Radix Vue, Zag, and UnoCSS.

To start developing, clone the repository and install the dependencies.

pnpm install

Then, build the packages:

pnpm build:pkg

To enable picking fonts from Google Fonts, you need to generate a Google Fonts Developer API Key. After that, create a .env file in the site folder and add the following:

NUXT_PUBLIC_GOOGLE_FONTS_KEY="YOUR_API_KEY"

Finally, you can start developing or building the site:

pnpm dev
pnpm build

 

Multilingual

This app currently supports:

  • English
  • Simplified Chinese
  • Spanish (@fmpaci)

To add a new language, create a translation file [language-code].yaml in the site/src/i18n folder. You can refer to the English version file as a guide. Finally, add the language code, name, icon, and translation file name in site/configs/i18n.ts.