Funkwhale design component library

The Funkwhale design component library is a collection of reusable UI components written in Vue.js and Sass.

Check out the documentation for information on how each component works and to see a live preview.

Dependencies

This library depends on the following external packages:

• vue
• vue-router
• vue-i18n
• @vueuse/core

You must install these packages for all components to work correctly.

Contribute to development

This project welcomes contributions! To get started make sure you have the following:

1. A design to follow
2. The use case for the component

Join the discussion on our forum to suggest new components.

Set up your environment

This project uses Yarn to manage dependencies and run development scripts. Make sure you have it installed before you start.

1. Install the project dependencies

   yarn install

2. Start a development server to preview your changes in real time

   yarn dev

Create a production-ready build

You can check how your code looks in production by creating a production-ready build.

1. Compile and minify your code for production

   yarn build

2. Preview the production-ready build

   yarn preview

Create and run tests

Writing tests for components minimizes the number of bugs that make it to production. This project uses the Vitest framework to run unit tests.

1. Write your test in the test directory

2. Run your unit tests

   yarn test

Contribute to documentation

Funkwhale UI components should be properly documented before release to make development easier. You should include examples, use cases, and lists of component props to ensure contributors know how to work with components without needing to read the code.

1. Start a development server to preview your changes in real-time

   yarn docs:dev

2. Create a production build of the documentation

   yarn docs:build

3. Serve a production build of the documentation

   yarn docs:serve

Release a new version

yarn version
yarn changelog
git add CHANGELOG.md && git commit --amend
git push --tags && git push