https://github.com/fundingcircle/sass-common

Common Sass mixins and files
https://github.com/fundingcircle/sass-common

frontend library styleguide ui

Last synced: 7 days ago
JSON representation

Common Sass mixins and files

• Host: GitHub
• URL: https://github.com/fundingcircle/sass-common
• Owner: FundingCircle
• License: bsd-3-clause
• Created: 2015-01-28T09:45:48.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-02-21T03:20:11.000Z (9 months ago)
• Last Synced: 2024-04-13T14:10:56.174Z (7 months ago)
• Topics: frontend, library, styleguide, ui
• Language: SCSS
• Size: 7.73 MB
• Stars: 15
• Watchers: 125
• Forks: 5
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# sass-common

This repository contains all the common `sass` mixins used across the new FC pages and the FC icon font.

## Requirements

* nodejs

* npm

## How to use

You can easily import this repository into your project using bower. Just amend `devDependencies` of your project's bower configuration file with:

```

"devDependencies": {

  "sass-common" : "[email protected]:FundingCircle/sass-common.git#1.0.0"

}

```

After that, run `bower install` and you are all set!

## Build

Source files are located in `src` and are built into the build directory. This is `dest` by default.

### Overriding the build path

You may want to override the build path, for example to develop styles on one of the other FundingCircle projects. Override the build path using the environment variable `BUILD_PATH`.

e.g.

```shell

$ BUILD_PATH=/path/to/fca-frontend gulp build

```

## Releasing a new version

1. Bump the version number in both the bower.json and package.json

1. Run `gulp build`

1. Commit and push to a branch

1. After code review, merge to master and tag with the same version number as you have defined in the config files in step 1.

1. Enjoy!

## Licence

This software is licensed under 3-clause BSD licence. Please see the LICENCE.md for details.