README.md

inkbeard

A Turborepo monorepo for inkbeard projects.

What's inside?

This includes the following packages/apps:

Apps

• ui-library: a storybook app for all the inkbeard components
• inkbeard: a vue3 app for inkbeard.com

Packages

• @inkbeard/ui-vue: a vue3/typescript component library shared throughout the monorepo
• @inkbeard/budget-it: a vue3/typescript package that provides budgeting tools that relies on @inkbeard/ui-vue
• @inkbeard/ui-theme: a set of theme variables shared throughout the monorepo

Congigurations

• @inkbeard/eslint-config: eslint configurations (includes eslint-config-next and eslint-config-prettier)
• @inkbeard/typescript-config: tsconfig.jsons used throughout the monorepo
• @inkbeard/stylelint-config: stylelint configurations

Getting started

In order to start things out, you need to have the following installed:

• pnpm and needs to be installed.
• Turborepo.
• Node.js v18+

Running applications

To run any of the applications, you can use the following command (after pnpm i if not already done):

# pnpm dev --filter name-of-workspace
pnpm dev --filter ui-library

Each application and package has its own README.md file with further instructions on how to build, test, run, etc.