whisthq/brave-ui

Whist's fork of brave-ui, a list of reusable React components to empower your Brave UI

Whist README

This repository is Whist's fork of brave-ui, with a few modifications. We forked brave-ui so that we could build Whist integrated within Chromium on top of Brave, to benefit from Brave's features and development pipeline.

Development

Before building or modifying the code, you should pull the latest changes from the public brave/brave-ui repository that this repository is forked from. To setup your repository, follow these steps:

1. Clone and enter the repository

git clone https://github.com/whisthq/brave-ui && cd brave-ui

2. Add the upstream repository as a remote

git remote add upstream https://github.com/brave/brave-ui

3. Disable pushing to upstream Brave UI

git remote set-url --push upstream DISABLE

After this, you should be able to list your remotes with git remote -v if you ever need to debug.

Since Brave UI is a large and active project, we will very often want to work with the latest upstream code; meanwhile, we need to make sure that our own repository has a sane commit history -- we cannot simply periodically merge the latest Brave UI on top of our own modifications.

Instead, perform the following steps to incorporate changes from upstream:

1. Fetch the latest changes to the upstream remote

git fetch upstream

2. Rebase on top of your current work

git rebase upstream/master
# git rebase upstream/<desired branch> for other upstream branches

3. Resolve merge conflicts, if any arise, and push to the Whist Brave UI repository

git push origin <current branch>

Building & Publishing

This project gets built via brave-browser. Please refer to that repository for instructions on building and publishing.

---

Brave README

Here you will find a list of reusable React components used in most of Brave products. Brave UI's component library can be found on Storybook.

❗Important: We are still hacking a lot on this project, and therefore don't recommend that anyone use it yet. It's free to try and use at your own risk but bear in mind that components and APIs are very likely to change without notice.

Installation

$ npm install

Using Brave UI

npm run storybook-start

Tests

We use Jest for testing. Playground is available under the stories/ folder.

npm run test-unit

License

This project is licensed under the MPL-2.0.