README.md 1.92 KB
Newer Older
1
# Masonstrap 4
David Haynes's avatar
DOCS  
David Haynes committed
2 3

[![build status](https://git.gmu.edu/srct/masonstrap/badges/master/build.svg)](https://git.gmu.edu/srct/masonstrap/commits/master) [![Gitlab license](https://img.shields.io/badge/license-MIT-blue.svg)](https://git.gmu.edu/srct/masonstrap/raw/master/LICENSE)
Thomas Park's avatar
Thomas Park committed
4

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

7
Masonstrap is a theme for bootstrap customized with GMU brand colors and
David Haynes's avatar
DOCS  
David Haynes committed
8 9 10
elements. It aims to easily provide any web project with Mason branding. This
repo contains all of the necessary components to build and modify masonstrap
on your local machine.
Thomas Park's avatar
Thomas Park committed
11

David Haynes's avatar
DOCS  
David Haynes committed
12
You can find information about how to use bootstrap in their official documentation:
Thomas Park's avatar
Thomas Park committed
13

David Haynes's avatar
DOCS  
David Haynes committed
14 15 16
[https://getbootstrap.com/](https://getbootstrap.com/)

## Adding Masonstrap to your project
David Haynes's avatar
David Haynes committed
17

David Haynes's avatar
DOCS  
David Haynes committed
18
You can download the latest version of Masonstrap at the following URL:
19

20
[https://git.gmu.edu/srct/masonstrap/-/jobs/artifacts/master/download?job=build](https://git.gmu.edu/srct/masonstrap/-/jobs/artifacts/master/download?job=build)
Thomas Park's avatar
Thomas Park committed
21

David Haynes's avatar
DOCS  
David Haynes committed
22 23
Included is the minified CSS for masonstrap, as well as other required static
files such as JS dependencies and fonts.
24

David Haynes's avatar
David Haynes committed
25 26 27 28 29 30 31 32 33
In lieu of serving the files yourself, you can utilize Gitlab Pages as a CDN:

```html
<link href="https://srct.gmu.io/masonstrap/css/masonstrap.min.css" rel="stylesheet">
<script src="https://srct.gmu.io/masonstrap/js/masonstrap.min.js" />
```

Note: Use at your own risk. :)

David Haynes's avatar
DOCS  
David Haynes committed
34
## Building Masonstrap yourself
35

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

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

David Haynes's avatar
Yarnn  
David Haynes committed
40
2. Install dependencies with Yarn:
David Haynes's avatar
David Haynes committed
41

David Haynes's avatar
Yarnn  
David Haynes committed
42 43
        sudo npm install -g yarn
        yarn
44

45
3. Install Gulp, the build system that we use:
Thomas Park's avatar
Thomas Park committed
46

47
        sudo npm install -g gulp-cli
David Haynes's avatar
DOCS  
David Haynes committed
48

49 50 51 52
4. Build Masonstrap

        gulp build

David Haynes's avatar
DOCS  
David Haynes committed
53
## Local development
54 55 56

You can spin up a development server with:

57
    gulp
58

59
Head to [127.0.0.1:8000](127.0.0.1:8000) to view!
60 61

Any changes made in `src/` are automatically applied to the dev server. DO NOT
David Haynes's avatar
David Haynes committed
62
EDIT IN `build/`, changes WILL NOT be committed.