chore: template configuration

This commit is contained in:
2025-12-20 16:37:24 +01:00
parent 5244110985
commit 978df91b6e
4 changed files with 9 additions and 86 deletions
+3 -62
View File
@@ -1,63 +1,4 @@
# Vue-boilerplate
*Minimal static Vue project*
# Coverify
*Create album covers from mundane photos*
<!-- TODO: 1. rename app (and tool URL) -->
### [Tool link](https://klemek.github.io/vue-boilerplate/)
## Use this template
<!-- TODO: 3. remove this part -->
### Creating project
#### Method 1: Using GitHub repository template
[Use this template](https://github.com/new?template_name=vue-boilerplate&template_owner=klemek)
#### Method 2: CLI forking
```bash
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](./README.md), [index.html](./index.html), [App.vue](./src/App.vue) and [package.json](./package.json)
2. [ ] Change app hue and saturation in [style.css](./public/style.css)
3. [ ] Remove this part and all TODO
### Updating from template
To update from templates latest changes:
```shell
make update-template
```
### Makefile targets
```txt
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](https://materialui.co/colors/) are available, you can use `class="red-500"` on your HTML
* [Lucide icons](https://lucide.dev/icons) are available, you can use `<LucideIcon name=house/>` on your Vue template
### [Tool link](https://klemek.github.io/coverify/)
+1 -2
View File
@@ -1,8 +1,7 @@
<!doctype html>
<html lang="en">
<head>
<!-- TODO: 1. rename app -->
<title>Change this you moron</title>
<title>Coverify</title>
<link rel="stylesheet" href="/style.css" />
<link rel="stylesheet" href="/material-colors.css" />
<!-- <link rel="icon" href="/favicon.ico"> -->
+2 -3
View File
@@ -85,9 +85,8 @@ CUSTOM STYLE
:root {
/* https://materialui.co/colors/ */
/* TODO: 2. change hue and saturation */
--hue-primary: 65.52;
--sat-primary: 20%;
--hue-primary: 199.53;
--sat-primary: 28.30%;
--background: hsl(var(--hue-primary), var(--sat-primary), 96.08%);
--background-primary: hsl(var(--hue-primary), var(--sat-primary), 93.33%);
--background-secondary: hsl(var(--hue-primary), var(--sat-primary), 90%);
+3 -19
View File
@@ -1,7 +1,6 @@
<script setup lang="ts">
import { ref, onMounted } from "vue";
import LucideIcon from "./components/LucideIcon.vue";
import CustomButton from "./components/CustomButton.vue";
const visible = ref<boolean>(false);
@@ -14,33 +13,18 @@ onMounted(() => {
<template>
<main :style="{ display: visible ? 'inherit' : 'none' }">
<!-- TODO: 1. rename app -->
<h1>
<LucideIcon name="package" />
Vue-Boilerplate
<LucideIcon name="disc-3" />
Coverify
</h1>
<br />
<p>
Fill this page with <i>whatever</i> you're going to develop.
<br />
<b>Then enjoy!</b>
</p>
<CustomButton>
<LucideIcon name="square-arrow-right" /> This is a sample button yay
</CustomButton>
<br />
<hr />
<small class="footer">
<LucideIcon name="at-sign" />
&nbsp;
<a href="https://github.com/klemek" target="_blank">klemek</a>
-
<!-- TODO: 1. rename app -->
<LucideIcon name="github" />
&nbsp;
<a href="https://github.com/klemek/vue-boilerplate" target="_blank">
Repository
</a>
<a href="https://github.com/klemek/coverify" target="_blank">Repository</a>
- 2025
</small>
</main>