@hilemangroup/bp-frontend/README.md

Common shared frontend utilities for boilerplate projects

# Common Assets

> Common shared frontend utilities for boilerplate projects

This project contains commonly used Sass and JavaScript files that can be imported into other projects via NPM or Yarn.

## Installation

To use this module, your computer needs:

- [NodeJS](https://nodejs.org/en/) (0.12 or greater)
- [Git](https://git-scm.com/)

To use this package in your own project, run the following command:

```bash
npm install @hilemangroup/bp-frontend
```

or

```bash
yarn add @hilemangroup/bp-frontend
```

## Development

Open the folder in your command line, and install the needed dependencies:

```bash
cd projectname
npm install
```

Finally, run `npm start` to run Gulp. Your finished site will be created in a folder called `dist`.

To create compressed, production-ready assets, run `npm run build`.