An open API service indexing awesome lists of open source software.

https://github.com/phucbm/single-web-page-boilerplate

A boilerplate to quickly build a single web page with GitHub pages deploy.
https://github.com/phucbm/single-web-page-boilerplate

atomic-css es6 github-actions github-pages webpack

Last synced: about 1 month ago
JSON representation

A boilerplate to quickly build a single web page with GitHub pages deploy.

Awesome Lists containing this project

README

          

# Single Web Page Boilerplate

[![github stars](https://badgen.net/github/stars/phucbm/single-web-page-boilerplate?icon=github)](https://github.com/phucbm/single-web-page-boilerplate/)
[![github license](https://badgen.net/github/license/phucbm/single-web-page-boilerplate?icon=github)](https://github.com/phucbm/single-web-page-boilerplate/blob/main/LICENSE)
[![Made in Vietnam](https://raw.githubusercontent.com/webuild-community/badge/master/svg/made.svg)](https://webuild.community)

A boilerplate to quickly build a single web page with:
- ⚙️ ES6 module
- ⚙️ Webpack with HRM ready
- ⚙️ SCSS
- ⚙️ Automation to deploy to GitHub Pages on every push

## Todos

1. Update `package.json` with your project info.
2. Start your code with `/site/index.js` **(do not rename this file)**.
3. Manage your site in folder `/site`.

## Deployment

```bash
# Install
npm i

# Run dev server
npm run dev

# Build production site with default path "/"
npm run build

# Build using GitHub Actions requires a different path
# domain.com or sub.domain.com => use "/"
# domain.com/your-site => use "/your-site"
npm run ghp-build
```