gob.cl framework
Set of tools for the design and layout of government web sites and applications.
Contains form templates, buttons, boxes, navigation menus and other design elements.
Based on Twitter Bootstrap.Content
Installation.
For install run:npm install @gobdigital-cl/gob.cl
Development.
Commands:
npm run build
for build gob.cl librarynpm run watch
for build gob.cl library and watch files for re-buildnpm run serve
for run site demo w/ browserSyncnpm run clean
for clean build files.
Best practicies
To maintain good code quality, you must maintan the standard. Here is a list of the main issues to be concerned when creating a new component:- Respect the framework design: Avoid using custom colors, custom fonts,
- Be aware of the different screen sizes: Your new component should look good
- Keep in mind the accessibility of your site: Not all users can access
- English is the standard: Class names, code comments, file name, this readme,
- Take care of the CASE: The way the different objects are written helps
Git flow
For development, you can use any Git Flow that meets your needs.Npm update
When you are ready with a new version to be published, you must update the npm package (only users with access to the package repository can update the npm package). To do this, follow the steps bellow:- Prepare the relase:
+ `npm run build`
- (Optional) Update the changelog file.
- Update the version number:
+ `npm version <update_type>`
- Publish to npm
+ `npm publish --access public`