Skip to content

Latest commit

 

History

History
126 lines (93 loc) · 3.94 KB

README.md

File metadata and controls

126 lines (93 loc) · 3.94 KB
Raw

ParcelJS and push-dir backed boilerplate

Built using Parcel backed boilerplate

MIT Licensed

Develop and publish simple Vanilla JS web apps with the least overheads.

Whenever you do not need any sophisticated app building tools and feel ES5/ES6 Vanilla JS and pure CSS sufficient you will benefit from using this boilerplate. Just start coding right off.

Table of Contents

TOC generated with DocToc

What's included

  • ParcelJS is a zero configuration web app bundler that supports HMR
  • push-dir is a tool to push built app to GitHub pages
  • shx to run one-off shell commands in npm package scripts working well under *nix and MS Windows environments (dev dependency)
  • normalize.css to reset styles making browsers render all elements more consistently and in line with modern standards (imported from ./src/index.js)
  • default-beauty.css to make default styles a bit more beautiful than offered by browsers (imported from ./src/index.js)
  • ./src/index.html with HTML5 compliant minimal content and inclusion of fonts to replace default plus Font Awesome to have nice icons
  • ./src/index.css and ./src/index.js to start coding with

Feel free getting rid of anything from the list above.

^ Up to TOC ^

Installation

You do not need to fork this repo unless you want to contribute to the project per se.

Install ParcelJS and push-dir globally:

yarn global add parcel-bundler && yarn global add push-dir

Install required dependencies:

yarn install

On GitHub create a new empty repository. Do not initialize it with any files. Take a note of .git url.

On your machine at a location of your preference run

git clone https://github.com/OleksiyRudenko/parcel-backed-boilerplate.git <your-project-name>
cd <your-project-name>
rm -rf .git
git init
git add .
git remote add origin <your-project-repo-url.git>

Now you are ready to make your first commit.

Consider removing whatever is not relevant to your project or changing files as appropriate before making initial commit and pushing it to your remote.

Files to consider changes to:

  • README.md (please keep reference to this project on the top)
  • CONTRIBUTING.md
  • index.html (please, keep links to parcel-backed-boilerplate and default-beauty.css somewhere within the file)
  • index.js
  • .github/*
  • .gitignore

^ Up to TOC ^

Workflow

  1. Run yarn start to launch development server with HMR support.
  2. Enjoy development benefiting from HMR
  3. Once you ready to publish:
    1. Terminate the development server
    2. yarn build to build project
    3. yarn push-gh-pages to publish the build on GitHub pages

yarn build-dev will build project without any minification, which may be useful for build debug purposes.

push-gh-pages requires git tree to be clean, so either commit or stash your uncommitted changes.

^ Up to TOC ^

Contributions

Contributions are welcomed. Please, check contribution notes

If you like this project and find it helpful, please, give it a ⭐ on github.

^ Up to TOC ^