README.md 1.34 KB
Newer Older
David Haynes's avatar
David Haynes committed
1
# Masonstrap (GMU bootstrap theme) [![build status](https://git.gmu.edu/srct/masonstrap/badges/master/build.svg)](https://git.gmu.edu/srct/masonstrap/commits/master)
Thomas Park's avatar
Thomas Park committed
2

David Haynes's avatar
David Haynes committed
3
A project of [GMU SRCT](http://srct.gmu.edu).
Thomas Park's avatar
Thomas Park committed
4

5
Masonstrap is a theme for bootstrap customized with GMU brand colors and
David Haynes's avatar
David Haynes committed
6
elements. It aims to easily provide any web project with Mason branding.
Thomas Park's avatar
Thomas Park committed
7

David Haynes's avatar
Yarnn  
David Haynes committed
8
## Adding Masonstrap to your project
Thomas Park's avatar
Thomas Park committed
9

David Haynes's avatar
David Haynes committed
10 11
This repo contains all of the necessary components to build and modify masonstrap
on your local machine. If you'd like just `masonstrap.min.css` head over to our
12
[pipelines page](https://git.gmu.edu/srct/masonstrap/pipelines) and download the
David Haynes's avatar
David Haynes committed
13 14 15
latest build of the css.

Additionally this link should grab you the latest css build:
16

David Haynes's avatar
Yarnn  
David Haynes committed
17
[https://git.gmu.edu/srct/masonstrap/builds/artifacts/master/download?job=build_css](https://git.gmu.edu/srct/masonstrap/builds/artifacts/master/download?job=build_css)
Thomas Park's avatar
Thomas Park committed
18

David Haynes's avatar
Yarnn  
David Haynes committed
19
## Building Masonstrap
20

21
If you would like to make changes to values or behaviors in Masonstrap you will
David Haynes's avatar
David Haynes committed
22
need to do some quick setup.
23

David Haynes's avatar
Yarnn  
David Haynes committed
24
1. Ensure `node.js` is installed:
Thomas Park's avatar
Thomas Park committed
25

David Haynes's avatar
Yarnn  
David Haynes committed
26
    https://nodejs.org/download/release/latest/
27

David Haynes's avatar
Yarnn  
David Haynes committed
28
2. Install dependencies with Yarn:
David Haynes's avatar
David Haynes committed
29

David Haynes's avatar
Yarnn  
David Haynes committed
30 31
        sudo npm install -g yarn
        yarn
32

David Haynes's avatar
David Haynes committed
33
3. Build the stylesheets:
Thomas Park's avatar
Thomas Park committed
34

David Haynes's avatar
David Haynes committed
35
        npm run build-masonstrap
Thomas Park's avatar
Thomas Park committed
36

David Haynes's avatar
David Haynes committed
37
    `masonstrap.css`, `masonstrap.min.css`, and a source map for masonstrap will be output to `./masonstrap/`.