Practical template for building static websites
Create a new repository on GitHub from this template at https://github.com/chalkygames123/front-end-template/generate or with GitHub CLI:
gh repo create my-project --public --clone --template chalkygames123/front-end-template
Alternatively, create a new directory and then run:
curl -fsSL https://github.com/chalkygames123/front-end-template/archive/main.tar.gz | tar -xz --strip-components=1
Right after the initialization, you may want to delete these files and directories or modify their content as you see fit:
.github
LICENSE
renovate.json
Several branches illustrate how to customize this template:
example/format-html
- format HTML outputexample/format-css
- format CSS outputexample/relative-paths
- use relative paths in HTML templatesexample/yakuhanjp
- use Yaku Han JP with SCSS
Remove everything from here and above
Project description
Make sure you have the version of Node.js specified in package.json#engines.node installed. By using Volta, you can automatically switch the version.
Install dependencies:
npm ci
Serve with live/hot reload at localhost:8080
:
npm run dev
Run all format checking:
npm run check
Run all formatters:
npm run format
Run all linters:
npm run lint
Run all linters with autofix:
npm run fix
Build for production:
npm run build