README.md 2.23 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

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 17

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

19
Masonstrap bundles bootstrap 3.7 and normalize.css for you.
20

21

22
# Building Masonstrap
23

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

David Haynes's avatar
David Haynes committed
27
1. Ensure node.js is installed:
28

29 30 31 32 33
    On Ubuntu: 
        
        sudo apt update
        sudo apt install nodejs
        sudo apt install npm
34

35 36 37 38
    On macOS: 
    
    1. make sure you have [Homebrew](http://brew.sh)
    2. `brew install node`
39

David Haynes's avatar
David Haynes committed
40
    On Windows, download it [here](https://nodejs.org/en/download/).
41

42
2. You will also need Sass which is distributed as a ruby gem:
Thomas Park's avatar
Thomas Park committed
43

44
    On Ubuntu:
Thomas Park's avatar
Thomas Park committed
45

46 47 48
        sudo apt update
        sudo apt install ruby
        sudo gem install sass
Thomas Park's avatar
Thomas Park committed
49

50
3. In the root directory of this project run:
51

52 53
        npm install
        bower install
54

55
4. Finally, run:
56

57
        grunt build
58

59
    to build the css files (`masonstrap.css` and `masonstrap.min.css`) in the `masonstrap/` directory.
Thomas Park's avatar
Thomas Park committed
60

61
# Local development
62

63
If you would like to run the demo site on your local machine run:
David Haynes's avatar
David Haynes committed
64

65
    grunt
66

67
This will spin up a local server at [127.0.0.1:3000]().
Thomas Park's avatar
Thomas Park committed
68

69
Any changes made to the `.scss` or `.html` files will trigger a rebuild of the css and livereload of the site. 
Thomas Park's avatar
Thomas Park committed
70

71
## Making changes to Masonstrap
David Haynes's avatar
David Haynes committed
72

73 74 75
Masonstrap consists of two Sass files. `_variables.scss`, which is included by
default in Bootstrap, allows you to customize [these settings](http://getbootstrap.com/customize/#less-variables).
`_masonstrap.scss` introduces more extensive structural changes.