https://github.com/InsaneNaman/parcel-static-site-starterkit
A starter kit to get Advanced features like SASS support, Uglification, Hot Module Reload in Static Website
https://github.com/InsaneNaman/parcel-static-site-starterkit
parcel starter-kit static-site
Last synced: about 2 months ago
JSON representation
A starter kit to get Advanced features like SASS support, Uglification, Hot Module Reload in Static Website
- Host: GitHub
- URL: https://github.com/InsaneNaman/parcel-static-site-starterkit
- Owner: InsaneNaman
- License: mit
- Created: 2020-10-03T15:20:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-09T17:34:22.000Z (about 2 years ago)
- Last Synced: 2024-11-13T16:42:47.919Z (7 months ago)
- Topics: parcel, starter-kit, static-site
- Language: HTML
- Homepage:
- Size: 270 KB
- Stars: 13
- Watchers: 2
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - InsaneNaman/parcel-static-site-starterkit - A starter kit to get Advanced features like SASS support, Uglification, Hot Module Reload in Static Website (HTML)
README
Read detailed blog on how and why to use at - [https://dev.to/insanenaman/starter-kit-for-static-websites-52hl](https://dev.to/insanenaman/starter-kit-for-static-websites-52hl)
## Parcel Static Website Starter
### Features 🚀
1- Compatible with All Static Site like Bootstrap Template
2- Out of the box Uglifying/ Minifying of CSS, HTML, JS
3- SCSS Support
4- ES6+ Support
5- Hot Reloading
6- Runs on a local server
7- Auto prefixing - Support IE10 and last 4 versions of all browsers
### How to use 🧐
`Make sure you have node installed. If not, I recommend installing via` [nvm(Node Version Manager)](https://github.com/nvm-sh/nvm)
1- Put your code in `src` folder
> There are sample files already present (feel free to delete them and add yours) to give you an idea about the architecture. You only to care about just one file i.e, `index.html`. You need to put at the `src` (`src/index.html`) folder level.
2- Install necessary packages - `npm i` or `yarn`
3- Run project (Development) - `npm run start` or `yarn run start`
4- Build(If you ready to deploy) - `npm run build` or `yarn run build`
### Commands available 🛠:
There are only three commands
1- `npm run start` - It starts a local server so that you can work on your project without any hustle. Enjoy Hot reloading (Live Updates in browser) and SASS/SCSS support.
2- `npm run build` - When you are ready to deploy. You can build your project and deploy the `dist` folder made by this command.
3- `npm run reset` - It just cleans `dist` (output folder) and `.cache` folder. Run this command before starting work on a new project. Parcel caches some files for the faster builds so its good to remove them before switching project.
### Advanced 👽
1- `.browserslistrc` - Default configuration targets IE-10 as well. If you don't want to support IE then you can delete configuration from this. Read more [here](https://github.com/browserslist/browserslist#browserslist-)
2- `.postcssrc` - This file is responsible to manage PostCSS plugin. This file can configure CSS plugins like AutoPrefixer, CSS Modules etc. Read more [here](https://parceljs.org/css.html#postcss)
3- Everything- This project has been built on top of [Parcel](https://parceljs.org). You can configure completely as you want.
### Creator 😈
Its Naman Gupta, FullStack Product Developer and FOSS lover.
Find me on [Twitter](https://twitter.com/InsaneNaman), [Linkedin](https://linkedin.com/in/InsaneNaman), [Dev.to](https://dev.to/InsaneNaman) and check out my [Portfolio](https://insanenaman.com)