@bimdata/utils

variable scss files re-usable on BIMDATA projects

Usage no npm install needed!

<script type="module">
  import bimdataUtils from 'https://cdn.skypack.dev/@bimdata/utils';
</script>

README

BIMData Utils

BIMData Utils is the library of BIMData, to quickly apply a design. See how this lib could be used, in the BIMData Styleguide

Requirements

  • node — build with version 10.15.3
  • npm — build with version 6.8.0

Use this lib in your project

Install the lib:

In the directory of your project:

npm i @bimdata/utils

Import CSS file: the css file is here:

./dist/css/main.css

Import SCSS file: the scss file is here:

./src/scss/main.scss

Internal development getting started

Before start:

Clone the Utils repository in your project directory.

Install dependencies:

The dependencies are listed in the package.json file.

npm install

Do this to make sure you are up-to-date on project dependencies

Launch auto local site:

And live-watch CSS modification while editing in the lib.

npm run dev

If you make scss changes inside the styleguide folder, don't forget to npm run build within this directory.

Build for prod:

CSS and JS minify

npm run build

Optimize SVG:

To optimize your svg and use it online, use this command.

npm run optimize-svg

It will compile your svg into the compiled folder of the dist folder

Use styles without using npm : You can also use the lib style without install it. For that, use UNPKG

License

GPL-3.0