thecreation / parcel-starter

A starter template for Parcel, ECMAScript(latest), sass and postcss.

Parcel Starter

A starter template for Parcel, ECMAScript(latest), sass and postcss.

Table of Contents

• Features
• Installation
• Getting Started
• List of Npm tasks

Features

This starter also features a number of great software (in the words of their creators):

• Parcel - blazing fast, zero configuration web application bundler.
• EditorConfig - a config file for maintaining consistent coding styles.

JavaScript

• Babel - a JavaScript compiler for es5 to es6/7.
• ESLint - the pluggable linting utility for JavaScript and JSX (with preconfigured ruleset by Google.

StyleSheet

• Sass - CSS with superpowers.
• PostCSS - a tool for transforming styles with JS plugins.
• Autoprefixer - adding vendor prefixes by the rules of Can I Use.
• Stylelint - a mighty, modern CSS linter (with preconfigured ruleset by Hugo Giraudel).

Git Hooks manager

• husky
• lint-staged

Installation

Node version manager

Install NVM. And use the latest version of NodeJS.

nvm install node
nvm use node

Install Sass

Go to sass-lang.com/install for installation in command line.

gem install sass

Before install sass, you should install Ruby and install Gem.

Getting started

1. Clone this Boilerplate

   git clone https://github.com/thecreation/parcel-starter.git <PROJECT_NAME>
   cd <PROJECT_NAME>

2. Install Dependencies

   npm install

3. Build the project

   npm run build

4. Stay up-to-date

   git remote add upstream https://github.com/thecreation/parcel-starter.git
   git pull upstream master

List of Npm tasks

To run separate task type in command line npm run [task_name].

Task name	Description
start	run the app in develpment.
build	build the app for production to the dist folder.
clean	remove dist folder.

License

The code is available under the MIT license.