@globalbrain/sefirot

Sefirot

This repository contains Vue Components for Global Brain Design System. Components are meant to be clean, sophisticated, and scalable.

Note that Sefirot is focused on being used in Global Brain's ecosystem. Hence the design—UI/UX—of components is quite fixed, and customization capability is limited. In exchange for customizability, we can create components that are more robust, dynamic, and clean.

That's being said, feel free to leverage any component within this project. You may customize them however you want, and if maybe, some component might be valuable to you. Any suggestion, request, or questions are welcome.

Documentation

You can check out the documentation for Sefirot at https://sefirot.globalbrains.com.

Contribution

We're really excited that you are interested in contributing to Sefirot. Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.

Code style guide

Sefirot follows official Vue Style Guide. But always remember to follow the "Golden Rule" below.

Every line of code should appear to be written by a single person, no matter the number of contributors.
— @mdo

Development

$ npm run serve

Serve documentation website at http://localhost:3000.

$ npm run lint

Lint files using a rule of Standard JS.

$ npm run jest

Run the test.

$ npm run coverage

Generate test coverage in coverage directory.

License

Sefirot is open-sourced software licensed under the MIT license.