@bojagi/cli
TypeScript icon, indicating that this package has built-in type declarations

0.18.1 • Public • Published

Bojagi - Bring your designers to code review

Bojagi Logo

DocumentationBojagi WebsiteJoin the open beta

💁‍♀️ 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!

🏆 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?

Demo of Bojagi

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!

🔮 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

License

3-Clause BSD License

Readme

Keywords

none

Package Sidebar

Install

npm i @bojagi/cli

Weekly Downloads

1

Version

0.18.1

License

BSD-3-Clause

Unpacked Size

542 kB

Total Files

523

Last publish

Collaborators

  • hyphe