Git Product home page Git Product logo

ml2015's Introduction

DS-GA 1003 Website

Development info

Building locally: quickstart

Be sure to have io.js installed. (Node.js will do if you feel like rockin' in 2013 style.)

Run npm install in the project root. This will install some build tools we use.

Run npm run watch to start a watcher that will compile things in place. You can then view the site by simply opening index.html.

Run npm run build to do a local build into the out/ directory. You can then preview the site at out/index.html. This should usually be the same as just index.html, but it is good to check before committing, since the build process is slightly more complicated than the in-place watch process.

Technologies used

Stylus is used for styling.

Handlebars is used for templating. index.hbs is minimally templated, mostly delegating to the partials in templates/. Those pull their data from data/. The logic that ties them all together is in build/templater.js.

Gulp is used for a build/watch system. This is abstracted behind npm tasks though (npm run watch, npm run build).

Traceur is used to write ES2015 code instead of boring-old-JavaScript, for the build code at least.

Travis is used to build and deploy the website to gh-pages on each push, per this guide.

The site is intended to be responsive, which we accomplish with per-device stylesheets and media queries in the HTML.

Things to Keep in Mind

While editing you should be using an EditorConfig plugin for your text editor to enforce a few basic stylistic things.

We are trying to maintain a reasonable HTML document outline (so, don't use <section> as if it were <div>). To preview the document outline, use the HTML 5 Outliner tool; here's a direct link to the outline for the current version.

ml2015's People

Contributors

davidrosenberg avatar domenic avatar jandet avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.