https://github.com/helpscout/brigade

⛑️ Brigade: Backbone-controlled React components
https://github.com/helpscout/brigade

backbone javascript jquery marionette open-source react

Last synced: about 1 month ago
JSON representation

⛑️ Brigade: Backbone-controlled React components

• Host: GitHub
• URL: https://github.com/helpscout/brigade
• Owner: helpscout
• License: mit
• Created: 2018-09-07T23:05:49.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-11-03T18:41:04.000Z (about 4 years ago)
• Last Synced: 2024-09-14T16:23:25.359Z (2 months ago)
• Topics: backbone, javascript, jquery, marionette, open-source, react
• Language: JavaScript
• Homepage: https://brigade.netlify.com/
• Size: 793 KB
• Stars: 8
• Watchers: 12
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ⛑️ Brigade

[![Build Status](https://travis-ci.org/helpscout/brigade.svg?branch=master)](https://travis-ci.org/helpscout/brigade) [![Coverage Status](https://coveralls.io/repos/github/helpscout/brigade/badge.svg?branch=master)](https://coveralls.io/github/%40helpscout%2Fbrigade?branch=master) [![npm version](https://badge.fury.io/js/%40helpscout%2Fbrigade.svg)](https://badge.fury.io/js/loggi)

> Backbone-controlled React components

## Table of Contents

- [What is Brigade?](#what-is-brigade)

- [Is Brigade for me?](#is-brigade-for-me)

- [Dependencies](#dependencies)

- [Installation](#installation)

- [Documentation](#documentation)

## What is Brigade?

Brigade is a library that enhances Backbone or Marionette views. It provides a

couple of abstractions for:

- Mounting one or more React components into a Backbone or Marionette view

- Keeping React components in sync with Backbone collections and models

- Using actions defined in a Backbone or Marionette view with a React component

## Is Brigade for me?

If you are integrating React components into a legacy Backbone/Marionette

application than Brigade may be a good fit for your project.

If you are simply looking for a state management solution for your React

project, then Brigade is not for you. In this case, try

[MobX](https://www.npmjs.com/package/mobx),

[Redux](https://www.npmjs.com/package/redux),

[Unistore](https://www.npmjs.com/package/unistore) or another solution.

## Dependencies

Brigade has the following peer dependencies:

- [Backbone](https://www.npmjs.com/package/backbone)

- [Marionette](https://www.npmjs.com/package/backbone.marionette)

- [React](https://www.npmjs.com/package/react)

- [React DOM](https://www.npmjs.com/package/react-dom)

- [React Redux](https://www.npmjs.com/package/react-redux)

- [Redux](https://www.npmjs.com/package/redux)

- [Redux Thunk](https://www.npmjs.com/package/redux-thunk)

Backbone requires jQuery and Underscore.

## Installation

```

npm install @helpscout/brigade

```

## Documentation

- Docs: [https://brigade.netlify.com](https://brigade.netlify.com)

- Storybook: [https://brigade-storybook.netlify.com](https://brigade-storybook.netlify.com)