description

A collection of components to be reused across personal projects. View live here

how to use (⚠️ alpha version ⚠️)

yarn add @e-krebs/react-library

Typescript types are included with the package.

The components can then be imported from the root of the package:

import { Checkbox, TextInput } from '@e-krebs/react-library';

in addition the the components, you can import the tailwindcss preset from the package:

• tailwind.config.js
• in which case, don't forget to include this package files in your tailwind content declaration

// tailwind.config.js
const shared = require('@e-krebs/react-library/tailwind.config.js');
module.exports = {
  presets: [shared],
  content: ['./src/**/*.{html,ts,tsx}', './node_modules/@e-krebs/react-library/dist/**/*.js'],
  theme: {
    extend: {},
  },
};

how to contribute

start by installing dependencies

bun install

dev

to run in dev:

bun run dev

this will:

• watch for changes on the library and continuously build it
• watch for changes on the stories and run the doc website on localhost:61000

production

to run in production mode:

bun run build

this will:

• first, build the library & the doc
• then, serve the doc site

publish

to publish a new documentation:

• push to main
• 🪄 the Vercel for Github app will do the rest!

to publish a new package:

• update the package.json version on main (ex: 1.0.0)
• create a new tag & release on github with the same version (ex: v1.0.0)
• 🪄 the GitHub publish workflow will do the rest!

TODO

• [ ] add more components
  • [x] Button v0.0.18
  • [ ] Card
  • [ ] DropDown
  • [ ] KeyCap
  • [ ] (external) Link
• [ ] reuse those components in:
  • [ ] pile
  • [ ] amaze
• [ ] publish beta
• [ ] tests
• [ ] publish stable