legume/README.md

Vue-boilerplate

Minimal static Vue project

Tool link

Use this template

Creating project

Method 1: Using GitHub repository template

Use this template

Method 2: CLI forking

git clone git@github.com/klemek/vue-boilerplate.git {PROJECT}
cd {PROJECT}
git remote rename origin template
git remote add origin {PROJECT REMOTE}

Tasks

Every task is indicated with a TODO

1. Rename app in README.md, index.html, App.vue and package.json
2. Change app hue and saturation in style.css
3. Remove this part and all TODO

Updating from template

To update from templates latest changes:

make update-template

Upgrade from version 1

git remote add template git@github.com:klemek/vue-boilerplate.git
git fetch --all
git checkout -b v1 origin/master
git branch -D master
git checkout -b master template/master
bun install
# re-code logic by checking online code
git commit -a -m 'v2'
git push origin master v1 --force
git remote --remove template

Makefile targets

Usage: make [target1] (target2) ...

Commands/Targets:
help                 show this message
build                build static site in "dist"
dev                  run dev version of static site
lint                 lint code
fix                  fix and reformat code
update-template      fetch and merge core changes from template

Environment:
BUN = bun

Tips

• Material design colors are available, you can use class="red-500" on your HTML
• Lucide icons are available, you can use <LucideIcon name=house/> on your Vue template