clayton-aldern / starter

A starter template for projects.

Home Page:https://github.com/the-pudding/starter

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The Pudding Starter Template

A starter template for projects.

If creating a brand new project from scratch: Follow setup instructions.

Else contributing to an existing project: clone the repo andd run npm install).

Please note: do not use or reproduce The Pudding logos or fonts without written permission.

Setup

Dependencies

Features

  • Parcel for JS bundling
  • Stylus for CSS pre-processing
  • Handlebars for HTML templating
  • ArchieML for micro-CMS (Google Docs -> JSON)
  • Feather for preset icons
  • Google Sheets -> JSON
  • Minifies, auto-prefixes, and inlines CSS
  • Inlines SVG
  • Async font loading (using font-display)

Usage

Use the starter CLI.

Usage (deprecated)

To create a new project, make a new directory (eg. mkdir project-name), cd into it, and run:

curl -Lk https://bit.ly/2J0L3MD > Makefile; make setup;

Documentation

See the generated README file in the new project directory for instructions.

About

A starter template for projects.

https://github.com/the-pudding/starter

License:MIT License


Languages

Language:JavaScript 46.7%Language:CSS 31.4%Language:HTML 21.3%Language:Makefile 0.6%