Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bojagi/bojagi
Public Bojagi node modules
https://github.com/bojagi/bojagi
storybook
Last synced: 3 months ago
JSON representation
Public Bojagi node modules
- Host: GitHub
- URL: https://github.com/bojagi/bojagi
- Owner: Bojagi
- License: bsd-3-clause
- Created: 2019-04-16T13:40:30.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-25T22:30:28.000Z (3 months ago)
- Last Synced: 2024-10-29T13:50:56.880Z (3 months ago)
- Topics: storybook
- Language: TypeScript
- Homepage: https://bojagi.io
- Size: 2.12 MB
- Stars: 13
- Watchers: 3
- Forks: 1
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bojagi - Bring your designers to code review ✅
[Documentation](https://bojagi.io/docs) ◆ [Bojagi Website](https://bojagi.io) ◆ [Join the open beta](https://bojagi.io/register)
## 💁♀️ What is Bojagi?
Bojagi is a service to review your UI changes visually. We are connected to your repository on GitHub and render
your components in real time. This way your teammates or designer can review the visual changes and play around
with your component. It's like hosting your Storybook, but more interactive.
Bojagi is currently in open beta, [join here!](https://bojagi.io/register)
## 🏆 Why use Bojagi?
Bojagi reduces your development cycle times by removing the back and forth of reviewing your UI designs on your
development environment.
* No more waiting until you deployed to staging or QA, do it before you merge to master! 🏃♀️
* Reduce communication effort: write comments, mark proposed changes visually and quickly give feedback 🚦
* Present your components to peers and customers without the need to click though your whole app 👩🎨
* See review feedback directly in GitHub 🤓
## 🤷♀️ How does it work?
Upload your components with our CLI and we display them! After you open your PR in GitHub you
can easily review all the changes. The review status is then automatically sent to GitHub so you
see if you got greenlit without needing to leave GitHub! Start with writing stories (Storybook works out of the box 📦).
[Look a the quickstart guide here!](https://bojagi.io/docs/quickstart.html)
## 🔮 How to use the CLI?
Install it into your project with yarn:
```
yarn add -D @bojagi/cli
```
or npm:
```
npm install --save-dev @bojagi/cli
```
After writing your stories you can test if everything works by listing the components:
```
yarn bojagi preview # or: npx bojagi preview
```
After that you can try to deploy to Bojagi:
```
yarn bojagi deploy # or: npx bojagi deploy
```
[Read more on using the CLI here](https://bojagi.io/docs/cli/)
## License
3-Clause BSD License