Welcome to simple asset server. It's meant for serving SHARED, static assets like css, js, and potentially image sprites. A number of subprojects could eventually co-exist on this asset server.
Load the site switcher via a <script> tag, and it will bootstrap the rest:
<script src="https://assets.govhack.org/js/site-switcher.min.js"></script>
- The bar will attach itself to the top of the
<body>tag. - It drags in a couple of external CSS stylesheets via
<link>tags.
Icon set: The GH Site Switcher uses WordPress Dashicons by default. if you want to force it to explicitly use either Dashicons or Font Awesome, then before including, create a GH variable in the window scope and give it some opts like such:
var GH = {};
GH.opts = {
useDashicons: false,
useFontAwesome: true
};
You can use the above technique to pre-set even more options. A number of options that you can pre-set are:
{
useDashicons: true | false, // default false
useFontAwesome: true | false, // default true
layoutStrategy: 'fixed' | 'block-padded', // default 'block-padded'
mobileHidden: true | false // default false
}
As an alternative to JavaScript option setting (for example if you don't want excess JS bootstrapping) then you can also define a couple of basic layout options as classnames in body. The main benefit of doing this is that it will be immediately visible as the HTML loads. (The JavaScript options will only come into effect at document.load). Classnames that can be added:
ghss-fixed: CSS to make the siteswitcherposition: fixedto the top (handy if you have other elements that areposition: fixedto the top)ghss-block-padded: CSS to add a spacer at the top of the body element, achieved by inserting adisplay: blockpseudo-element.ghss-mobile-hidden: Hide it on mobile, viewport width <600px
This is a node.js project, please ensure you've got Node installed. Then clone this repo to the server:
git clone [email protected]:govhackaustralia/asset-server.git
Install all the node deps
npm install
Since this is your first run, go ahead and build the scss outputs. This can simply be triggered via the gulpfile. It will dump the outputs into /public/css and and /public/js
gulp
Then start the server. Recommended that you use http-server to serve the directory.
You could run this server using PM2. A utility script is located in the root folder called up.sh
Maybe use a service like AWS ELB to reverse-proxy the node.js server. The up.sh script sets the node http-server to run on :3010
Note: GovHack asset server should support both https:// and http:// happily depending on its load balancer's/reverse proxy's configuration