kalkhoff-assets
v0.10.10
Published
Kalkhoff - Brand Appearance Guide Assets
Downloads
79
Readme
kalkhoff-assets
Start with:
- npm install
- composer install
Then to generate less and sass assets/sources:
npm run build
For development/watch you can run the build with watch by using:
npm run dev
And to test less and sass sources:
npm run test
Icon Fonts
In order to make the icon font generation work, you will need to install a few dependencies local on your device:
Make sure you installed brew
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Install the software to generate icons:
brew install batik fontforge ttfautohint ttf2eot
Combined settings
Most settings are defined in the settings folder (json files). All these settings get automatically converted into less and scss settings. Make sure to use these files in order to keep consistency
Rules 🤡
For class naming, use strict bem naming (.{{block}}__{{element}}--{{modifier}}
), if you don't we will chase you till the end of time! More info: http://getbem.com/naming/
Frontend Section/Component flow
1. Start front-end feature
* Start feature branch
* Update Jira
* Add label “WIP + Your name” to element in BAG
2. Deliver feature
* Go through Checklist:
* mobile
* as designed
* has all elements
* right BEM method
* No conflicts with other components
* Create Pull request to develop
* Update Jira
* Change BAG label to “Checking”
3. Check and Validate with design dept.
* Send link to design
4. Publish to UAT
* After check update label to “Finished”
* Pull request Develop to Staging
Publish assets to npm
If you want to show of your work on the Brand Appearance Guide you first have to publish the assets to npm, this is how:
- Commit all your code to publish
- In terminal run
npm version <patch|minor|major>
choose your type of versioning wisely depending on your level of work - Push everything to your feature branch
- Create pull request to the
release
branch - Once approved the bitbucket pipeline will publish to npm for you
- Push your Brand Appearance Guide to staging once npm is published