https://github.com/adamgiebl/parcel-boilerplate
📦 Parcel boilerplate with automatic deployment to GitHub pages
https://github.com/adamgiebl/parcel-boilerplate
gh-pages github-pages parcel parcel-boilerplate scss
Last synced: 9 months ago
JSON representation
📦 Parcel boilerplate with automatic deployment to GitHub pages
- Host: GitHub
- URL: https://github.com/adamgiebl/parcel-boilerplate
- Owner: adamgiebl
- Created: 2020-11-22T23:24:18.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-12-30T21:03:56.000Z (over 5 years ago)
- Last Synced: 2025-02-24T04:45:25.569Z (over 1 year ago)
- Topics: gh-pages, github-pages, parcel, parcel-boilerplate, scss
- Language: HTML
- Homepage:
- Size: 47.9 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Parcel boilerplate
Use Parcel with GitHub pages to get a seamless development experience.
## Why to use this one?
Besides all the default Parcel features:
- includes Sass
- easy deployment into the `gh-pages` branch. Not a manual process, just run the `npm run deploy` command
- examples of how to import images, split code and link main files are included in the repo, no need to figure it out
- no configuration
## How to use
- if you haven't already, install [Parcel](https://parceljs.org/getting_started.html) globally
- run `npm install`
- turn on the source for GitHub pages to be the `gh-pages` branch, if it doesn't exist it will be created automatically by the build script
- link `scss` or `sass` files directly inside `index.html` or import them in javascript
- set the homepage inside package.json to follow this format `https://[your_gh_username].github.io/[your_repo_name]`, basically whatever the domain of your github page will be e.g. https://adamgiebl.github.io/neumorphism. If you have a custom domain then use that one
## Scripts
- `npm start` or `npm run dev` to run a local server with live reload
- `npm run deploy` to build and deploy into the gh-pages branch