Neanderthals Programming Machines

    htz-sassbp

    2.1.3 • Public • Published

    HTZ-sassBP

    A sass boilerplate for the Haaretz Group websites

    Installation

    Install dependancies

    Using the boilerplate requires having the following installed:

    Install boilerplate

    cd into your project's front-end root directory and run:
    npm install --save htz-sassbp

    This will download the boilerplate files into the node_modules directory and note them as dependencies in the project's package.json.
    Please make sure the the node_modules directory is not version controlled (i.e. ignored)

    You can now @import the boilerplate files to your project's sass files using a relative path (most likely ../node_modules/htz-sassbp/styles/<filename>.

    To kickstart the configuration of your project, copy the content of the node_modules/htz-sassbp/baseline/ directory from the boilerplate to the project, and edit the files in it.
    The basline provides a prject's directory structure, as well as a minimal screen.scss and configuration files under the settings directory.

    Updating to a newer version

    To update the boilerplate with recent changes, first note the current version installed in the project:

    cd <project-dir>
    npm list htz-sassbp

    Then, go to (https://github.com/Haaretz/htz-sassbp/releases) and check if there are any breaking chenges between the currently installed version and latest. If there are, and they are relevant to your project, implement them in you project when upgrading.
    When you are ready to upgrade, npm install htz-sassbp@* --save in your project's root. Don't forget to commit package.json and notify everyone else of the changes.

    Documentation

    See documentation here

    Keywords

    none

    Install

    npm i htz-sassbp

    DownloadsWeekly Downloads

    0

    Version

    2.1.3

    License

    GPL

    Last publish

    Collaborators

    • eranm6
    • maozzadok
    • haaretz-owner
    • txhawks
    • tbanin