Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 2.17 KB

README.md

File metadata and controls

67 lines (41 loc) · 2.17 KB
Raw

This is an archive. Repo moved to https://github.com/NUSComputingDev/freshmen.nuscomputing.com

NUS Computing Freshmen Orientation Project 2016 Website

FOP 2016

Virtutem Quattuor

Production site: http://freshmen.nuscomputing.com/
Staging site: https://meebleforp.com/projects/fop/

This repo contains the source code to build the SoC FOP 2016 website. The site is largely static, written in Jade and SASS with Bootstrap, a touch of JavaScript with jQuery and built with Gulp. Pull requests welcome!

To build:

  1. Make sure you have node and npm installed
  2. Clone this repo
  3. Install dependencies - npm install
  4. Copy the example config file and edit it - cp config.json.example config.json
  5. Build with gulp - gulp build --env [your environment] (eg. gulp build --env local)

To develop:

  1. Follow steps 1 - 4 from above
  2. Start the local dev server by running gulp serve. Your browser will automatically open up http://localhost:3000, where you should see the site being served locally
  3. Get cracking! Any changes made to any of the source files should automatically trigger browser reload courtesy of BrowserSync

Environment variables

locals - object

Variables to be passed to the templates. Required variable:

  • baseUrl - base URL to the site, to be used for all links and local resources. URL should include protocol. For local development this is set to http://localhost:3000

output - string

Folder relative to the project root to write the built files to. Include the suffix -build (eg. production-build), which will be ignored by git.

urlRewrite - boolean [default: false]

Copies a .htaccess file into the root folder that removes the .html suffix from all URLs. Only works with Apache.

reload - boolean [default: true]

Reloads BrowserSync when the build is done. Used for local development builds.

minify - boolean [default: false]

Minifies resources (currently only CSS via SASS). Used for production builds.

sourcemaps - boolean [default: true]

Generate source maps for the CSS