amber-visual
Styleguide & visual assets for the Amber Design System.
This repository is aimed mainly to developers and contributors, for the proper documentation & styleguide please refer to https://amber.bitrock.it.
Usage
Install
$ yarn add @amber-ds/visual
--- or ---
$ npm install @amber-ds/visual
Add in project
Compiled .css
, no tooling:
<link rel="stylesheet" href="./node_modules/@amber-ds/visual/dist/index.css">
Importing source .scss
within a .scss
file with Webpack:
@import "~@amber-ds/visual";
Importing source .scss
within a .js
file with Webpack:
import '@amber-ds/visual';
Development
Getting started
Clone the repo
$ git clone git@github.com:bitrockteam/amber-visual.git && cd amber-visual
Install dependencies
$ yarn
--- or ---
$ npm install
Available NPM tasks
Start the project in development mode (live reload)
$ yarn start
Create a static build in the ./dist
folder
$ yarn build
How to contribute
Please refer to our contributing document.
Publish a new version
Before attempting to publish a new version of the package on NPM, first run through this checklist:
- tests passes (it is required for PRs)
- increment version number in
package.json
file following semver guidelines - report the changes on the amber-website docs
License
Developed by Bitrock UI Engineering team, released under the MIT license.