Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/appfolio/react-gears
AppFolio component library for React & Bootstrap
https://github.com/appfolio/react-gears
circleci react
Last synced: 5 days ago
JSON representation
AppFolio component library for React & Bootstrap
- Host: GitHub
- URL: https://github.com/appfolio/react-gears
- Owner: appfolio
- License: bsd-2-clause
- Created: 2016-09-21T22:15:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T22:35:15.000Z (3 months ago)
- Last Synced: 2024-10-20T09:27:26.774Z (2 months ago)
- Topics: circleci, react
- Language: JavaScript
- Homepage: https://appfolio.github.io/react-gears
- Size: 115 MB
- Stars: 17
- Watchers: 83
- Forks: 9
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# react-gears
react-gears is a React implementation of Appfolio UI components, using
[React](https://reactstrap.github.io),
[Bootstrap 4](http://getbootstrap.com),
and [reactstrap](https://reactstrap.github.io).
https://appfolio.github.io/react-gears
----
## Getting Started
```
yarn add @appfolio/react-gears
# or for npm:
npm install @appfolio/react-gears
```
### Example
```js
import React from 'react';
import { Button } from '@appfolio/react-gears';
export default (props) => {
return (
Danger!
);
};
```
### [Cypress](https://www.cypress.io) Testing
You can use [react-gears-cypress](https://github.com/appfolio/react-gears-cypress) for testing react-gears components in your project.
----
## Development
Install dependencies:
```
yarn install
```
Run storybook examples:
```
yarn start
```
Then open [http://localhost:6006](http://localhost:6006) in a browser.
Run tests:
```
yarn test
```
This runs unit tests using [Mocha](https://mochajs.org/) and [enzyme](http://airbnb.io/enzyme/index.html).
Run Linter
```
yarn lint
```
This runs [ESLint](http://eslint.org/) using [appfolio-react](https://github.com/appfolio/eslint-config-appfolio-react) as the base configuration.
----
## Contributing
### Commit messages
Commit messages should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format:
```
():
```
Here's an example commit message:
```
feat(SomeComponent): add new thing that does something
```
- `` is optional.
- `!` indicates a breaking change. Example: `feat!: some breaking change`.
Here are a few common ``s:
- `feat`: A new feature
- `fix`: A bug fix
- `docs`: Documentation changes
- `refactor`: Code changes that neither fix a bug nor add a feature
- `test`: Adding missing tests or correcting existing tests
- `ci`: Changes to CI configuration files and scripts
- `chore`: Other changes that don't modify src or test files
For more information about Conventional Commits, see the [official documentation](https://www.conventionalcommits.org/en/v1.0.0/).
### Merging changes
Open a pull request, get it approved by the relevant code owners, and merge your pull request.
**IMPORTANT**: Make sure your pull request is rebased when merged. The merge button has dropdown options. Choose "Rebase and merge".
### Creating a prerelease
- Open a pull request with your changes against the default branch.
- After a few minutes, GitHub bot will leave a comment on the pull request notifying the prerelease was created.
- Use this prerelease version (e.g. 8.0.1-some-branch-a48dadc.0) to test your changes in apps/libraries that depend on this library.
### Creating an official release
After merging your pull request to the default branch, [release-please](https://github.com/googleapis/release-please) will automatically create or update a special "release pull request".
- Find this "release pull request" under the "Pull requests" tab for this repo. The title will be something like, **chore(master): release 8.0.2**.
- Approve and merge this "release pull request" to create an official release (e.g. 8.0.2).