Skip to content
/ plinth Public

A solid and simple base for front-end web projects

License

Notifications You must be signed in to change notification settings

spenno/plinth

Repository files navigation

Plinth

A solid and simple base for front-end web projects using Sass, JavaScript, task automation and linting.

Installing

On a Mac, launch Terminal (or your preferred alternative) and install the Xcode Command Line Tools:

$ xcode-select --install

If you've recently installed Xcode you might need to launch it and accept the terms and conditions.

Install Node.js by running the Node Version Manager (NVM) install script:

$ curl -o- https://github.com/raw/creationix/nvm/master/install.sh | bash

If you're using Z shell, replace bash with zsh in the above install script.

Follow the instructions for restarting Terminal or using NVM straight away.

Check to see what version of Node.js is installed:

$ nvm list

Check the latest stable version of Node.js available for download:

$ nvm ls-remote --lts | grep Latest

To install to the latest version if you want / need to:

$ nvm install --lts

Check that the expected Node.js version is installed and active:

$ node -v

Update the Node.js Package Manager, NPM:

$ npm install -g npm

Install the Gulp command line utility:

$ npm install --g gulp-cli

Install all of Plinth's required packages:

$ npm install

Usage

Run 'gulp' to start in development mode and watch for Sass and JavaScript changes.

$ gulp

Run 'gulp prod' to minify CSS and JavaScript ready for production.

$ gulp prod

Built with

  • Sass Boilerplate - A boilerplate for Sass projects
  • Gulp - Automate and enhance your workflow
  • include-media - Simple, elegant and maintainable media queries in Sass
  • Modular Scale - Setting type to levels in a scale
  • Stylelint - A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
  • ESLint - The pluggable linting utility for JavaScript and JSX
  • Babel - JavaScript compiler

About

A solid and simple base for front-end web projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published