generator-cheetah

1.0.9 • Public • Published

3-Step Installation Process

  • npm install -g yo
  • npm install generator-cheetah
  • yo cheetah

##Cheetah. TLDR: Takes a folder of scss or sass files and transforms into a single optimised .css file; providing sourcemaps on all builds. Also compresses index.html and bundles all the .js files resepectively.

  • npm run build
  • npm run start
  • npm run release

###Getting Started Please note that webpack is expecting index.js and index.html as your main files. The generator will handle the rest. This project supports React version 16.8.*, but you will need to merge your package.json dependencies with ours to ensure that you have the required node modules to run your project.

###npm run build (production build)

  • creates 'contenthashed' file for caching
  • uses optimisation, such as minification, removal of whitespace, attribute quotes, etc. for js and css.
  • uses MiniCssExtractPlugin for styling
  • uses webpack dev-tool 'source-map' for production.

###npm run start

  • creates standard bundled js file
  • transforms scss into css and css into js, and injects into dom
  • uses webpack dev-tool 'inline-source-map' for development

###npm run release

  • unoptimised build. Merges all styling into the release folder under one .css file 'zebra.css'. This is used for further development and comes with the npm release of this package.

License

MIT © Marc Adlington

Package Sidebar

Install

npm i generator-cheetah

Weekly Downloads

0

Version

1.0.9

License

MIT

Unpacked Size

12.3 kB

Total Files

13

Last publish

Collaborators

  • marcadlington