README.md

🌳 Boemly

Boemly is the open source component library maintained by Tree.ly based on ChakraUI.

🏃‍♀️ Getting started

Install Boemly:

npm i boemly --save

Include the theme provider in the root of your app and start using the Boemly components:

import { Button, BoemlyThemeProvider } from 'boemly';

function App() {
  return (
    <BoemlyThemeProvider>
      <Button>Button</Button>
    </BoemlyThemeProvider>
  );
}

export default App;

📚 Documentation

You can find a detailed documentation of Boemly here.

🚀 Contributing

We are happy about every contribution from our community! Please follow our contribution guideline.

💻 Development

For development on Boemly check out our development docs.

⚙️ Technologies used

• Typescript as the programming language.
• @emotion for custom styles.
• react-use as a collection of hooks.
• Framer for animations.
• Eslint combined with Prettier as a linter/formatter.
• Jest as the testing framework.
• Storybook for the design system and component documentation.

🌲 Who is behind Boemly

Boemly is maintained by Tree.ly.