https://github.com/yesnoruly/parcel-start

Clone this repo to start your own projects!
https://github.com/yesnoruly/parcel-start

boileplate css gh-pages html parcel postcss posthtml-include starter-template template

Last synced: 2 months ago
JSON representation

Clone this repo to start your own projects!

• Host: GitHub
• URL: https://github.com/yesnoruly/parcel-start
• Owner: yesnoruly
• License: mit
• Created: 2020-12-06T13:18:40.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-15T17:10:14.000Z (9 months ago)
• Last Synced: 2024-08-03T18:16:23.672Z (6 months ago)
• Topics: boileplate, css, gh-pages, html, parcel, postcss, posthtml-include, starter-template, template
• Language: CSS
• Homepage: https://yesnoruly.github.io/parcel-start/
• Size: 166 KB
• Stars: 5
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-parcel - Parcel Start - Simple starter template for plain web sites. (Examples)

README

        
# Parcel start

[![GitHub](https://img.shields.io/github/license/yesnoruly/parcel-start)](https://github.com/yesnoruly/parcel-start/blob/master/LICENSE)

[![GitHub deployments](https://img.shields.io/github/deployments/yesnoruly/parcel-start/github-pages?label=Deploy)](https://github.com/yesnoruly/parcel-start/actions)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](https://github.com/yesnoruly/parcel-start/pulls)

A simple parcel starter template for plain websites.

## Features

- 📝 HTML Includer

- 🔢 Autoprefixer

- 🎡 Automatic deploy to gh-pages branch

- 🔄 CSS reset

## Demo

[Demo](https://yesnoruly.github.io/parcel-start/)

## Quick start

#### `npm install`:

Install the dependencies.

#### `npm run dev`:

Run the app, you can view the app by visiting `http://localhost:1234/`.

---

#### `npm run build`:

Builds the website for production to the dist folder.

## Github Pages Deploy

If you want to deploy your website on gh-pages, you need to:

1. Check the branch name in the [`deploy.yml`](https://github.com/yesnoruly/parcel-start/blob/master/.github/workflows/deploy.yml) file

2. In the `package.json` specify the following fields:

```json

"homepage": "https://%your-name%.github.io/%rep-name%",

"scripts": {

    "build": "parcel build src/*.html --public-url /%rep-name%/"

}

```

## Related

Here are some related projects

[awesome-parcel#examples](https://github.com/parcel-bundler/awesome-parcel#examples)