Compass

React implementation of Syneto's Compass Design System.

View DOCS

---

Setup

npm i @syneto/compass-react

Include styles in your main file:

import "@syneto/compass-react/lib/styles.css"

Import and use components:

// for simple components, use named exports
import { Badge, Button, Dropdown } from "@syneto/compass-react"

// for complex components, use separate default exports
import DatePicker from "@syneto/compass-react/lib/DatePicker"
import Form from "@syneto/compass-react/lib/Form"
import Modal from "@syneto/compass-react/lib/Modal"
import Tabs from "@syneto/compass-react/lib/Tabs"

---

Development

1. Clone the repo and install dependencies:

npm install

2. Use develop branch (or a feature/branch, then merge to develop):

git checkout develop

3. Run the development server using React Styleguidist:

npm run develop

4. Run tests:

npm test

// update snapshots
npm run test:update

Commit messages

All relevant commits should have the following message:

type(category): description [flags]

Where type is one of the following:

• feat: for New Features
• fix: for Bug Fixes
• breaking: for Breaking Changes
• docs: for Documentation Changes
• build: for Build System / Dependencies updates
• perf: for Performance Improvements
• refactor: for Refactors
• test: for Tests
• chore: for Chores / Routine tasks
• other: for any Other Changes

And flags is one of the following:

• breaking: alters type to be a breaking change

Examples:

feat(Badge): New Badge component
feat(Button): Add loading prop

fix(Dialog): Modal dialog should not close when clicking outside (#12)

docs(Button): add loading Button examples
// category is optional
docs: add new section for colors

build(docs): add loading Button examples

fix(Button): changed prop loading to isLoaded [breaking]

---

Release

We use Semantic Versioning for releases.

1. Choose between Major/Minor/Patch release:

// patch version: a release that contains fixes, without breaking changes or new features
npm run release:patch

// minor version: a release that contains at least one new feature, without breaking changes
npm run release:minor

// major version: a release that contains at least one breaking change
npm run release:major

2. Merge into master, which will cause an auto-deploy to Github Pages:

git checkout master
git merge develop
git push origin master

3. Publish to npm registry:

npm publish --access public

---

About this project

Based on this starter kit.

What's included:

• Rollup and Babel for generating a bundle of your library in ES5
• React Styleguidist and Webpack for developing/testing the UI components interactively
• Prettier, ESLint, and Stylelint for code formatting/linting
• Sass and Autoprefixer support for simple styling
• Jest for unit testing components
• Changelog generator
• Bundle vizualizer