upstatement/puppy

Starter kit and delivery system for building static prototypes with Twig

puppy's Issues

Add a favicon gulp task

"we should add a task to generate favicon, app icons, etc from an image file"

Remove jQuery?

From looking, it seems like main.js is the only place where jQuery is used. Is this something we could get rid to lighten the dependency load?

Add documentation for contributors

Set up Dependabot

Add README

README: add graphicsmagick

Puppy thumbnail images rely on ImageMagick, therefore I think we should add this to the ReadMe under installation:

brew install graphicsmagick

Consider adding a Gulp task for image optimization

@NathanHass Has been using this one a bunch:

const resizeImages = async function() {
  const sizes = [
    { width: 320, quality: 0.9, suffix: '' },
    { width: 640, quality: 0.9, suffix: '-640' },
    { width: 768, quality: 0.9, suffix: '-768' },
    { width: 1024, quality: 0.9, suffix: '-1024' },
    { width: 1440, quality: 0.9, suffix: '-1440' },
  ];

  let stream;

  sizes.forEach(size => {
    stream = src('src/img/**/*.{jpg,png}')
      //     resize image
      .pipe(
        imageResize({
          width: size.width,
          upscale: false,
          quality: size.quality,
        }),
      )
      //       add suffix to image
      .pipe(
        rename(path => {
          path.basename += `${size.suffix}`;
        }),
      )
      //     output optimized images to a destination folder
      .pipe(dest('dist/static/img'));
  });
  return stream;
};

Add usage documentation

The Basics

• How to start a new project
• How to work on a project
  • Initial setup
  • Dev workflow
  • Adding pages
  • Adding templates
  • Front Matter headers
  • Data fixtures
  • Authoring styles
  • Authoring Javascript
  • Adding third party dependencies
  • Adding static files (fonts, images, etc.)
• How to deploy a project
  • Creating a production build
  • Netlify

Advanced Topics (for later)

• Modifying Webpack configuration
• Modifying Gulp configuration

Document removal of test files

The test files are needed for this repo, but not by projects scaffolded from it. The end result is failing TravisCI builds as soon as any updates are made.

Set up lightweight testing w/ CI

Depenendabot is great, but requires manual testing to make sure dependency updates don't break things.

Update prototype index styles