README.md 1.98 KB
Newer Older
David Haynes's avatar
DOCS    
David Haynes committed
1
2
3
# Masonstrap 4 (Beta 1)

[![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

David Haynes's avatar
DOCS    
David Haynes committed
20
[https://git.gmu.edu/srct/masonstrap/builds/artifacts/master/download?job=build](https://git.gmu.edu/srct/masonstrap/builds/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
DOCS    
David Haynes committed
25
## Building Masonstrap yourself
26

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

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

David Haynes's avatar
Yarnn    
David Haynes committed
31
2. Install dependencies with Yarn:
David Haynes's avatar
David Haynes committed
32

David Haynes's avatar
Yarnn    
David Haynes committed
33
34
        sudo npm install -g yarn
        yarn
35

David Haynes's avatar
David Haynes committed
36
3. Build the stylesheets:
Thomas Park's avatar
Thomas Park committed
37

David Haynes's avatar
David Haynes committed
38
        npm run build-masonstrap
Thomas Park's avatar
Thomas Park committed
39

David Haynes's avatar
DOCS    
David Haynes committed
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
    Head to `./public/assets/css` to find built masonstrap css files.

## Local development

You can dev on masonstrap either in Docker or on your local machine, whichever
you prefer.

### Docker

Assuming you have Docker and Docker Compose installed:

    docker-compose up

Will run a process to rebuild masonstrap on any changes and spin up a dev server
at [127.0.0.1:8000](http://127.0.0.1:8000)

### Manual setup

Spin up a process to watch for changes and rebuild masonstrap on the fly:

    npm start

Spin up a local web server to view the demo site:

    npm run http

Head to [127.0.0.1:8000](http://127.0.0.1:8000) to see the demo site!