UNPKG

bit-bin

Version:

<a href="https://opensource.org/licenses/Apache-2.0"><img alt="apache" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a> <a href="https://github.com/teambit/bit/blob/master/CONTRIBUTING.md"><img alt="prs" src="https://img.shields.io/b

80 lines (54 loc) 4.25 kB
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="apache" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a> <a href="https://github.com/teambit/bit/blob/master/CONTRIBUTING.md"><img alt="prs" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"></a> <a href="https://circleci.com/gh/teambit/bit/tree/master"><img alt="Circle Status" src="https://circleci.com/gh/teambit/bit/tree/master.svg?style=shield&circle-token=d9fc5b19b90fb7e0655d941a5d7f21b61174c4e7"> [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) <a href="https://join.slack.com/t/bit-dev-community/shared_invite/enQtNzM2NzQ3MTQzMTg3LWI2YmFmZjQwMTkxNmFmNTVkYzU2MGI2YjgwMmJlZDdkNWVhOGIzZDFlYjg4MGRmOTM4ODAxNTIxMTMwNWVhMzg" ><img alt="Join Slack" src="https://img.shields.io/badge/Slack-Join%20Bit%20Slack-blueviolet"/></a> [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Share%20code%20components%20as%20a%20team%20@bitdev_&url=https://bit.dev&hashtags=opensource,javascript,programming,reactjs,webdev,vuejs,angularjs) # Bit is the platform for collaborating on components ![Bit Workflow](https://storage.googleapis.com/static.bit.dev/docs/images/quick_start.png) [Documentation](https://docs.bit.dev) • [Tutorials](https://docs.bit.dev/docs/tutorials/bit-react-tutorial) • [Quick start guide ](https://docs.bit.dev/docs/quick-start) • [Workflows](https://docs.bit.dev/docs/workflows/workflows) • [bit.dev components cloud](https://bit.dev) • [Video demo](https://www.youtube.com/watch?v=E5lgoz6-nfs) ## What is Bit? 🤔 Bit is an [open-source](https://github.com/teambit/bit) cli tool for collaborating on isolated components across projects and repositories. Use Bit to distribute discrete components from a design library or a project into a standalone reusable package and utilize it across applications. You can set up your own server for components collaboration, or use the [bit.dev cloud](#bitdev-cloud-%EF%B8%8F) hosting for private and public components sharing. ## Why Bit? 🎖️ Bit facilitates the process of collaborating on UI components. Team members can share, maintain, and synchronize isolated components from different projects. Bit allows teams to: - Increase code reusability - Increase design and development efficiency - Retain UI and UX consistency - Increase project's stability ## Key Features 🔑 - Extract a component for sharing directly from an existing library or project. - Validate the component's independence by building and testing each component separately from the rest of the project. - Change the source code of shared components from any application that utilizes it. - Get published changes in components on top of local modifications. - Contribute back changes made to components directly from the consuming applications. - Automatically wrap each component as an npm package. - Distribute discrete components instead of a single massive package. - Automate component versioning according to changes in its dependencies. - Use with leading frameworks and tools: React, Vue, Angular, Mocha, Jest. - Works alongside Git, NPM, and Yarn. Bit is working with Javascript and Javascript frameworks: <img src="https://storage.googleapis.com/static.bit.dev/docs/images/js_logos.png"> ## Installation 🚪 Using npm: ```bash npm install bit-bin --global ``` Using yarn: ```bash yarn global add bit-bin ``` Bit cli requires node 8.12 and above. Check other [installation](https://docs.bit.dev/docs/installation) methods. ## bit.dev cloud 🌩️ Use [bit.dev](https://bit.dev) cloud hosting solution as a shared server and showcase for your components. <p align="center"> <a href="https://bit.dev"><img src="https://storage.googleapis.com/bit-docs/component-discovery-bit-react-gif.gif"></a> </p> ## Contributing 🎗️ Contributions are always welcome, no matter how large or small. Before contributing, please read the [code of conduct](CODE_OF_CONDUCT.md). See [Contributing](CONTRIBUTING.md). ## License 💮 Apache License, Version 2.0 ![Analytics](https://ga-beacon.appspot.com/UA-96032224-1/bit/readme)