Skip to content

Latest commit

 

History

History
107 lines (80 loc) · 4.02 KB

README.md

File metadata and controls

107 lines (80 loc) · 4.02 KB
Raw

English / 简体中文

TickTime

Web License Language Repo Stars Last Commit

A application that elegantly displays the current time and an inspirational quote, designed to fit perfectly within any screen size.

Preview

Just feel it. website.complex website.simple

complex complex mobile
simple simple mobile

Features

  • Displays current time and an inspirational quote.
  • Random quote generation from public/quotes.txt.
  • Fully responsive design for any screen size.
  • Easy to customize the quote and share it with others.
  • URL is all. Records the time and quote in the URL link.

API Description

URL Parameters

  • quote: The quote to display. This parameter allows users to customize the quote shown on the bottom.
  • records: Encoded data containing notes and timestamps. This data is stored in the URL and can be shared with others to reproduce the same page.

format: YYYY-MM-DDThh.mm.ssZ{_note} Z is UTC time zone. use | to split snapshots.

Example URL

https://ticktime.xj63.fun/?quote=Click+here+to+edit+quote.&records=2024-12-18T15.51.22Z|2024-12-18T15.51.24Z_hello
quote=Click+here+to+edit+quote. # bottom show quote: 'Click here to edit quote.'
records=2024-12-18T15.51.22Z|2024-12-18T15.51.24Z_hello # timesnap data
time note
2024-12-18T15.51.22Z
2024-12-18T15.51.24Z hello

Deploy

You can fork this project and deploy it on GitHub Pages.

Notice: ensure that the base url is right.

// file ./vite.config.js
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import vueDevTools from 'vite-plugin-vue-devtools'

// https://vite.dev/config/
export default defineConfig({
  base: '/your-base-url/', // set your base url in here, example is your project name.
  plugins: [
    vue(),
    vueDevTools(),
  ],
  resolve: {
    alias: {
      '@': fileURLToPath(new URL('./src', import.meta.url))
    },
  },
})

./.github/workflows/deploy.yml is the workflow to run bun run build to branch gh-pages.

Set github project config gh-pages to github pages.

Contributing Quotes

We welcome contributions to our quotes collection! Please add your favorite quotes to the public/quotes.txt file. PR/Issue are most welcome.