Parcel starter kit

Starter kit based on parcel bundler, used for web development 👩‍💻

Table of content

• About the Project
• Requirement
• Getting Started
• Usage
• Project tree
• Acknowledgements
• Used packages

About this Project

I've created this template 📓 to speed up creation of the projects, installing all the necessery packages, writing scripts, creating file structure 📂 can be time consuming and annoying 🤯 This template will help you with that 😎

Requirement

If you don't have already installed Node.js and yarn just do it now !

Getting Started

Click on Use this template button and follow instructions, clone your repo on your computer, go to the project folder and in console type yarn install. Yarn will install all needed packages after that you are ready to code 👨‍💻

Usage 🔧

yarn dev - runs development mode

yarn build - runs build process for production

yarn test - runs jest tests

yarn test:report - build coverage report

yarn lint - runs eslinter

yarn lint:fix - runs eslint and trying to the fix errors

yarn publish - runs build and publish the page using gh-pages branch

Project tree 🌳

.
├── node_modules
├── src
│   ├── tests
│   ├── assets
│   │   └── images
│   │       └── icons
│   ├── sass
│   │   ├── layout
│   │   ├── base
│   │   │   ├── _typography.scss
│   │   │   ├── _variables.scss
│   │   │   └── _reset.scss
│   │   ├── main.scss
│   │   ├── components
│   │   └── pages
│   ├── js
│   │   └── index.js
│   └── pages
│       └── index.html
├── babel.config.js
├── package.json
├── cover-image.png
├── jest.config.js
├── README.md
└── yarn.lock

Acknowledgements 📖

• Yarn - docs
• Prettier
• Eslint
• Getting Prettier, Eslint and Vscode to work together
• What is Babel?
• Parcel - Getting Started
• Jest - Getting Started
• Sass

Used packages 📦

• @babel/core
• @babel/preset-env
• babel-jest
• eslint
• eslint-config-airbnb-base
• eslint-config-prettier
• eslint-plugin-import
• eslint-plugin-prettier
• jest
• parcel
• prettier
• sass
• gh-pages