bpk68 / parcel-template

A Parcel JS starter template

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Parcel bundler starter kit

If you're looking to get started using the Parcel JS bundler as a Webpack alternative, then this is the place for you.

Following on from a recent blog post on using Parcel JS as a Webpack alternative, I've put together this quick and simple starter kit so you can worry less about the setup and configuration and more about developing!

Getting started

It couldn't be easier to get started. Simply fork or clone the repo into a local folder and run the yarn install command:

yarn install

This will install the following dependencies:

  • Parcel JS bundler
  • Babel (including the env preset)

Running the starter kit

If you checkout the package.json file, you'll see two scripts, one for development and one for building a production bundle.

To start the development server, you'll want this command:

yarn start

This will quickly bundle all of the necessary files and kick off the development server, which is generated at http://localhost:1234.

How to use the starter kit

Everything is kept quite simple and as unopinionated as possible so that you can start developing quickly and however you choose.

Included in the project is a link to a kick-off app.scss file where you can load in any CSS you want.

The important files of note are:

  • /index.html -- this is where the project starts and Parcel looks for its first bundle starting point
  • /src/app.scss -- as mentioned, the first file where the system looks for CSS information
  • /src/index.js -- the initial JavaScript file that Parcel comes across as a starting point; it simply injects a string into the index.html page

Issues, questions, more information?

If you run into any issues, have any questions or would like more information then please see the follow sections:

  • Issues > please log an issue in the project issues tab
  • Questions > again, this might be a better place for the issues tab, but you can also email me on me[at]robkendal.co.uk
  • More information or support > it's worth checking out the official Parcel JS documenttation for more help on adding extra things or customising your build and project setup.

About

A Parcel JS starter template

License:MIT License


Languages

Language:HTML 68.3%Language:SCSS 17.7%Language:JavaScript 14.0%