https://github.com/treely/boemly
The open-source design system of Tree.ly
https://github.com/treely/boemly
chakra-ui component-library design-system ui
Last synced: 3 months ago
JSON representation
The open-source design system of Tree.ly
- Host: GitHub
- URL: https://github.com/treely/boemly
- Owner: treely
- License: mit
- Created: 2022-02-11T14:56:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-04-14T15:14:45.000Z (3 months ago)
- Last Synced: 2026-04-14T15:25:30.492Z (3 months ago)
- Topics: chakra-ui, component-library, design-system, ui
- Language: TypeScript
- Homepage: https://boemly.tree.ly
- Size: 3.94 MB
- Stars: 38
- Watchers: 3
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 🌳 Boemly
[](https://github.com/treely/boemly/actions)
[](https://github.com/semantic-release/semantic-release)
[](https://www.npmjs.com/package/boemly)
Boemly is the open source component library maintained by Tree.ly based on
[ChakraUI](https://chakra-ui.com/).
## 🏃♀️ Getting started
Install Boemly:
```bash
npm i boemly --save
```
Include the theme provider in the root of your app and start using the Boemly components:
```jsx
import { Button, BoemlyThemeProvider } from 'boemly';
function App() {
return (
Button
);
}
export default App;
```
## 📚 Documentation
You can find a detailed documentation of Boemly [here](https://boemly.tree.ly).
## 🚀 Contributing
We are happy about every contribution from our community! Please follow our
[contribution guideline](CONTRIBUTING.md).
## 💻 Development
For development on Boemly check out our [development docs](CONTRIBUTING.md#development).
## ⚙️ Technologies used
- [Typescript](https://www.typescriptlang.org/) as the programming language.
- [@emotion](https://emotion.sh/docs/introduction) for custom styles.
- [@reactuses/core](https://www.npmjs.com/package/@reactuses/core) as a collection of hooks.
- [Framer](https://www.framer.com/docs/) for animations.
- [Eslint](https://eslint.org/) combined with [Prettier](https://prettier.io/)
as a linter/formatter.
- [Jest](https://jestjs.io/) as the testing framework.
- [Storybook](https://storybook.js.org/) for the design system and component
documentation.
## 🌲 Who is behind Boemly
Boemly is maintained by [Tree.ly](https://tree.ly).
