├── public ├── .assetsignore └── favicon.svg ├── .github ├── assets │ └── banner.png ├── renovate.json └── workflows │ ├── ci.yaml │ └── docker.yaml ├── src ├── env.d.ts ├── lib │ ├── utils.ts │ └── config.ts ├── components │ ├── ui │ │ ├── skeleton.tsx │ │ ├── icon.tsx │ │ ├── avatar.tsx │ │ └── button.tsx │ ├── ErrorPage.astro │ ├── Footer.astro │ ├── ModeToggle.tsx │ ├── backgrounds │ │ ├── dot-pattern.tsx │ │ ├── custom-background.tsx │ │ ├── grid-pattern.tsx │ │ ├── animated-grid.tsx │ │ └── flickering-grid.tsx │ ├── ButtonContainer.tsx │ ├── Background.astro │ └── UserContainer.tsx ├── layouts │ └── Layout.astro ├── pages │ └── index.astro ├── types.ts └── styles │ └── global.css ├── .vscode ├── extensions.json ├── launch.json └── settings.json ├── wrangler.jsonc ├── tsconfig.json ├── .gitignore ├── astro.config.ts ├── components.json ├── eslint.config.js ├── docker ├── Dockerfile ├── default.json └── .dockerignore ├── package.json ├── shako.config.ts ├── README.md └── LICENSE /public/.assetsignore: -------------------------------------------------------------------------------- 1 | _worker.js 2 | _routes.json -------------------------------------------------------------------------------- /.github/assets/banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keksiqc/shako/HEAD/.github/assets/banner.png -------------------------------------------------------------------------------- /src/env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | /// 3 | -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": ["astro-build.astro-vscode"], 3 | "unwantedRecommendations": [] 4 | } 5 | -------------------------------------------------------------------------------- /wrangler.jsonc: -------------------------------------------------------------------------------- 1 | { 2 | "name": "shako", 3 | "compatibility_date": "2025-12-03", 4 | "assets": { 5 | "directory": "./dist" 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /src/lib/utils.ts: -------------------------------------------------------------------------------- 1 | import type { ClassValue } from 'clsx' 2 | import { clsx } from 'clsx' 3 | import { twMerge } from 'tailwind-merge' 4 | 5 | export function cn(...inputs: ClassValue[]) { 6 | return twMerge(clsx(inputs)) 7 | } 8 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "astro/tsconfigs/strict", 3 | "compilerOptions": { 4 | "jsx": "react-jsx", 5 | "jsxImportSource": "react", 6 | "baseUrl": ".", 7 | "paths": { 8 | "@/*": ["./src/*"] 9 | } 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | "command": "./node_modules/.bin/astro dev", 6 | "name": "Development server", 7 | "request": "launch", 8 | "type": "node-terminal" 9 | } 10 | ] 11 | } 12 | -------------------------------------------------------------------------------- /.github/renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "config:best-practices", 5 | "group:allNonMajor", 6 | ":semanticCommitTypeAll(chore)" 7 | ], 8 | "lockFileMaintenance": { 9 | "enabled": true 10 | }, 11 | "labels": [ 12 | "renovate" 13 | ] 14 | } 15 | -------------------------------------------------------------------------------- /src/components/ui/skeleton.tsx: -------------------------------------------------------------------------------- 1 | import { cn } from '@/lib/utils' 2 | 3 | function Skeleton({ className, ...props }: React.ComponentProps<'div'>) { 4 | return ( 5 |
10 | ) 11 | } 12 | 13 | export { Skeleton } 14 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # build output 2 | dist/ 3 | 4 | # generated types 5 | .astro/ 6 | 7 | # dependencies 8 | node_modules/ 9 | 10 | # logs 11 | npm-debug.log* 12 | yarn-debug.log* 13 | yarn-error.log* 14 | pnpm-debug.log* 15 | 16 | # environment variables 17 | .env 18 | .env.production 19 | 20 | # macOS-specific files 21 | .DS_Store 22 | 23 | # editors 24 | .idx/ 25 | .idea/ 26 | -------------------------------------------------------------------------------- /astro.config.ts: -------------------------------------------------------------------------------- 1 | import react from '@astrojs/react' 2 | import playformCompress from '@playform/compress' 3 | import tailwindcss from '@tailwindcss/vite' 4 | import { defineConfig } from 'astro/config' 5 | 6 | import config from './shako.config' 7 | 8 | // https://astro.build/config 9 | export default defineConfig({ 10 | vite: { 11 | plugins: [tailwindcss()], 12 | }, 13 | integrations: [react(), playformCompress()], 14 | redirects: config.page.redirects, 15 | }) 16 | -------------------------------------------------------------------------------- /components.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://ui.shadcn.com/schema.json", 3 | "style": "new-york", 4 | "rsc": false, 5 | "tsx": true, 6 | "tailwind": { 7 | "config": "", 8 | "css": "src/styles/global.css", 9 | "baseColor": "neutral", 10 | "cssVariables": true, 11 | "prefix": "" 12 | }, 13 | "aliases": { 14 | "components": "@/components", 15 | "utils": "@/lib/utils", 16 | "ui": "@/components/ui", 17 | "lib": "@/lib", 18 | "hooks": "@/hooks" 19 | }, 20 | "iconLibrary": "lucide" 21 | } 22 | -------------------------------------------------------------------------------- /src/lib/config.ts: -------------------------------------------------------------------------------- 1 | import type { ParsedConfig } from '@/types' 2 | import { loadConfig } from 'c12' 3 | import * as v from 'valibot' 4 | import { configSchema } from '@/types' 5 | 6 | export async function getConfig(): Promise { 7 | const config = await loadConfig({ 8 | name: 'shako', 9 | }) 10 | 11 | if (!config) { 12 | console.error('No configuration found') 13 | return null 14 | } 15 | 16 | const result = v.safeParse(configSchema, config.config) 17 | 18 | if (result.success) { 19 | return result.output 20 | } 21 | else { 22 | console.error(v.summarize(result.issues)) 23 | return null 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /eslint.config.js: -------------------------------------------------------------------------------- 1 | // eslint.config.js 2 | import path from 'node:path' 3 | import process from 'node:process' 4 | 5 | import antfu from '@antfu/eslint-config' 6 | import tailwind from 'eslint-plugin-tailwindcss' 7 | 8 | export default antfu({ 9 | stylistic: true, 10 | react: true, 11 | astro: true, 12 | ignores: ['README.md'], 13 | }, tailwind.configs['flat/recommended'], { 14 | rules: { 15 | 'tailwindcss/no-custom-classname': 'off', 16 | 'react-hooks-extra/no-direct-set-state-in-use-effect': 'off', 17 | }, 18 | settings: { 19 | tailwindcss: { 20 | callees: ['cn', 'cva'], 21 | // Construct an absolute path to your global.css 22 | config: path.join(process.cwd(), 'src/styles/global.css'), 23 | }, 24 | }, 25 | }) 26 | -------------------------------------------------------------------------------- /src/components/ErrorPage.astro: -------------------------------------------------------------------------------- 1 | --- 2 | interface Props { 3 | error: string 4 | } 5 | 6 | const { error } = Astro.props; 7 | --- 8 | 9 |
10 |
11 |
12 |
13 |

Error

14 |

Configuration Error

15 |
16 | 17 |
18 | 19 |
20 |

{error}

21 |

22 | Please check your configuration and try again. 23 |

24 |
25 |
26 |
27 |
28 | -------------------------------------------------------------------------------- /public/favicon.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docker/Dockerfile: -------------------------------------------------------------------------------- 1 | # Build stage 2 | FROM oven/bun:1.3-alpine@sha256:7156fcc0cee0194d390bfaf7f0eeda9a5e383e70cc90f31aad3a2440a033d7dc AS builder 3 | 4 | # Add build arguments 5 | ARG NODE_ENV=production 6 | ENV NODE_ENV=${NODE_ENV} 7 | 8 | WORKDIR /app 9 | 10 | # Copy package files first 11 | COPY package.json bun.lock ./ 12 | 13 | # Install dependencies with specific flags for production 14 | RUN bun install --frozen-lockfile 15 | 16 | # Copy only necessary source files 17 | COPY src/ ./src/ 18 | COPY public/ ./public/ 19 | COPY shako.config.ts ./ 20 | COPY astro.config.ts ./ 21 | COPY tsconfig.json ./ 22 | 23 | # Build the application 24 | RUN bun run build 25 | 26 | # Production stage 27 | FROM 11notes/caddy:2.10.0@sha256:d3739d44070d9eb0f0c09d8a207ba124553abc385f31c6278ba657d50f969113 28 | 29 | # Copy built assets from builder 30 | COPY --from=builder /app/dist /caddy/var/ 31 | COPY ./docker/default.json /caddy/etc/default.json 32 | 33 | # Expose port 34 | EXPOSE 80 443 35 | 36 | # Start Caddy 37 | ENTRYPOINT ["/usr/local/bin/caddy"] 38 | CMD ["run", "--config", "/caddy/etc/default.json"] 39 | -------------------------------------------------------------------------------- /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | workflow_dispatch: 5 | push: 6 | branches: 7 | - main 8 | pull_request: 9 | paths-ignore: 10 | - '**/*.md' 11 | 12 | jobs: 13 | lint: 14 | name: Lint 15 | runs-on: ubuntu-latest 16 | steps: 17 | - name: Checkout 18 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 19 | 20 | - name: Set up Bun 21 | uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # v2 22 | with: 23 | bun-version: 1.3.4 24 | 25 | - name: Cache Bun dependencies 26 | uses: actions/cache@9255dc7a253b0ccc959486e2bca901246202afeb # v5 27 | with: 28 | path: ~/.bun/install/cache 29 | key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }} 30 | restore-keys: | 31 | ${{ runner.os }}-bun- 32 | 33 | - name: Install dependencies 34 | run: bun install --frozen-lockfile 35 | 36 | - name: Astro check 37 | run: bun run check 38 | 39 | - name: Lint with ESLint 40 | run: bun run lint 41 | -------------------------------------------------------------------------------- /docker/default.json: -------------------------------------------------------------------------------- 1 | { 2 | "apps": { 3 | "http": { 4 | "servers": { 5 | "health": { 6 | "listen": ["127.0.0.1:3000"], 7 | "routes": [ 8 | { 9 | "handle": [{ 10 | "handler": "static_response", 11 | "status_code": 200 12 | }] 13 | } 14 | ] 15 | }, 16 | "shako": { 17 | "listen": [":80", ":443"], 18 | "routes": [ 19 | { 20 | "handle": [ 21 | { 22 | "encodings": { 23 | "gzip": {} 24 | }, 25 | "handler": "encode", 26 | "prefer": [ 27 | "gzip" 28 | ] 29 | }, 30 | { 31 | "handler": "file_server", 32 | "root": "/caddy/var" 33 | } 34 | ] 35 | } 36 | ] 37 | } 38 | } 39 | } 40 | }, 41 | "storage": { 42 | "module": "file_system", 43 | "root": "/caddy/var" 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /src/components/ui/icon.tsx: -------------------------------------------------------------------------------- 1 | import { lazy, Suspense } from 'react' 2 | import { cn } from '@/lib/utils' 3 | 4 | // Lazy load the Icon component 5 | const IconComponent = lazy(() => import('@iconify/react').then(mod => ({ default: mod.Icon }))) 6 | 7 | interface IconProps extends React.HTMLAttributes { 8 | icon: string 9 | size?: 'sm' | 'md' | 'lg' 10 | fallbackClassName?: string 11 | } 12 | 13 | const sizeClasses = { 14 | sm: 'size-4', 15 | md: 'size-5', 16 | lg: 'size-6', 17 | } 18 | 19 | function IconFallback({ className }: { className?: string }) { 20 | return
21 | } 22 | 23 | export function Icon({ icon, size = 'md', className, fallbackClassName, ...props }: IconProps) { 24 | return ( 25 |
26 | }> 27 | 33 |
34 | ) 35 | } 36 | -------------------------------------------------------------------------------- /docker/.dockerignore: -------------------------------------------------------------------------------- 1 | # Dependencies 2 | node_modules/ 3 | .npm/ 4 | .yarn/ 5 | .pnpm/ 6 | 7 | # Environment files 8 | .env 9 | .env.* 10 | *.env 11 | 12 | # Development 13 | .git/ 14 | .gitignore 15 | .vscode/ 16 | *.log 17 | npm-debug.log* 18 | yarn-debug.log* 19 | yarn-error.log* 20 | pnpm-debug.log* 21 | 22 | # Build output 23 | dist/ 24 | .astro/ 25 | build/ 26 | out/ 27 | 28 | # OS files 29 | .DS_Store 30 | Thumbs.db 31 | desktop.ini 32 | *.swp 33 | *.swo 34 | 35 | # Testing 36 | coverage/ 37 | test/ 38 | __tests__/ 39 | *.test.* 40 | *.spec.* 41 | vitest.config.* 42 | jest.config.* 43 | 44 | # Editor files 45 | .idea/ 46 | *.sublime-* 47 | *.code-workspace 48 | .settings/ 49 | 50 | # Project specific 51 | README.md 52 | CHANGELOG.md 53 | LICENSE 54 | *.md 55 | Dockerfile 56 | .dockerignore 57 | .eslintrc* 58 | .prettier* 59 | .style* 60 | components.json 61 | 62 | # Config files (except those needed for build) 63 | .*rc* 64 | *.config.js 65 | !astro.config.ts 66 | !tsconfig.json 67 | !shako.config.ts 68 | 69 | # Cache 70 | .cache/ 71 | .temp/ 72 | *.tsbuildinfo 73 | .eslintcache 74 | .stylelintcache 75 | 76 | # Temporary files 77 | tmp/ 78 | temp/ 79 | *.tmp 80 | -------------------------------------------------------------------------------- /src/components/Footer.astro: -------------------------------------------------------------------------------- 1 | --- 2 | import { Code, Heart } from 'lucide-react' 3 | 4 | export interface Props { 5 | footerConfig?: string | boolean 6 | } 7 | 8 | const { footerConfig } = Astro.props 9 | 10 | // Early return for disabled footer 11 | if (footerConfig === false) { 12 | return null 13 | } 14 | 15 | const isCustomContent = typeof footerConfig === 'string' 16 | --- 17 | 18 | 46 | -------------------------------------------------------------------------------- /src/components/ModeToggle.tsx: -------------------------------------------------------------------------------- 1 | import { Moon, Sun } from 'lucide-react' 2 | import * as React from 'react' 3 | 4 | import { Button } from '@/components/ui/button' 5 | 6 | export function ModeToggle() { 7 | const [theme, setThemeState] = React.useState< 8 | 'theme-light' | 'dark' | 'system' 9 | >('theme-light') 10 | 11 | React.useEffect(() => { 12 | const isDarkMode = document.documentElement.classList.contains('dark') 13 | setThemeState(isDarkMode ? 'dark' : 'theme-light') 14 | }, []) 15 | 16 | React.useEffect(() => { 17 | const isDark 18 | = theme === 'dark' 19 | || (theme === 'system' 20 | && window.matchMedia('(prefers-color-scheme: dark)').matches) 21 | document.documentElement.classList[isDark ? 'add' : 'remove']('dark') 22 | }, [theme]) 23 | 24 | return ( 25 | 34 | ) 35 | } 36 | -------------------------------------------------------------------------------- /src/components/ui/avatar.tsx: -------------------------------------------------------------------------------- 1 | import { Avatar as AvatarPrimitive } from 'radix-ui' 2 | import * as React from 'react' 3 | 4 | import { cn } from '@/lib/utils' 5 | 6 | function Avatar({ 7 | className, 8 | ...props 9 | }: React.ComponentProps) { 10 | return ( 11 | 19 | ) 20 | } 21 | 22 | function AvatarImage({ 23 | className, 24 | ...props 25 | }: React.ComponentProps) { 26 | return ( 27 | 32 | ) 33 | } 34 | 35 | function AvatarFallback({ 36 | className, 37 | ...props 38 | }: React.ComponentProps) { 39 | return ( 40 | 48 | ) 49 | } 50 | 51 | export { Avatar, AvatarFallback, AvatarImage } 52 | -------------------------------------------------------------------------------- /src/components/backgrounds/dot-pattern.tsx: -------------------------------------------------------------------------------- 1 | import { useId } from 'react' 2 | import { cn } from '@/lib/utils' 3 | 4 | interface DotPatternProps extends React.SVGProps { 5 | width?: number 6 | height?: number 7 | x?: number 8 | y?: number 9 | cx?: number 10 | cy?: number 11 | cr?: number 12 | className?: string 13 | [key: string]: unknown 14 | } 15 | 16 | export function DotPattern({ 17 | width = 16, 18 | height = 16, 19 | x = 0, 20 | y = 0, 21 | cx = 1, 22 | cy = 1, 23 | cr = 1, 24 | className, 25 | ...props 26 | }: DotPatternProps) { 27 | const id = useId() 28 | 29 | return ( 30 | 53 | ) 54 | } 55 | -------------------------------------------------------------------------------- /src/layouts/Layout.astro: -------------------------------------------------------------------------------- 1 | --- 2 | import '@fontsource/geist-sans' 3 | import '@fontsource/geist-mono' 4 | 5 | interface Props { 6 | title: string 7 | } 8 | 9 | const { title } = Astro.props 10 | --- 11 | 12 | 30 | 31 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | {title} 42 | 43 | 44 | 45 | 46 | 47 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | // Disable the default formatter, use eslint instead 3 | "biome.enabled": false, 4 | "prettier.enable": false, 5 | "editor.formatOnSave": false, 6 | 7 | // Auto fix 8 | "editor.codeActionsOnSave": { 9 | "source.fixAll.eslint": "explicit", 10 | "source.organizeImports": "never" 11 | }, 12 | 13 | // Silent the stylistic rules in you IDE, but still auto fix them 14 | "eslint.rules.customizations": [ 15 | { "rule": "style/*", "severity": "off", "fixable": true }, 16 | { "rule": "format/*", "severity": "off", "fixable": true }, 17 | { "rule": "*-indent", "severity": "off", "fixable": true }, 18 | { "rule": "*-spacing", "severity": "off", "fixable": true }, 19 | { "rule": "*-spaces", "severity": "off", "fixable": true }, 20 | { "rule": "*-order", "severity": "off", "fixable": true }, 21 | { "rule": "*-dangle", "severity": "off", "fixable": true }, 22 | { "rule": "*-newline", "severity": "off", "fixable": true }, 23 | { "rule": "*quotes", "severity": "off", "fixable": true }, 24 | { "rule": "*semi", "severity": "off", "fixable": true } 25 | ], 26 | 27 | // Enable eslint for all supported languages 28 | "eslint.validate": [ 29 | "javascript", 30 | "javascriptreact", 31 | "typescript", 32 | "typescriptreact", 33 | "vue", 34 | "html", 35 | "markdown", 36 | "json", 37 | "json5", 38 | "jsonc", 39 | "yaml", 40 | "toml", 41 | "xml", 42 | "gql", 43 | "graphql", 44 | "astro", 45 | "svelte", 46 | "css", 47 | "less", 48 | "scss", 49 | "pcss", 50 | "postcss" 51 | ] 52 | } 53 | -------------------------------------------------------------------------------- /src/pages/index.astro: -------------------------------------------------------------------------------- 1 | --- 2 | import Background from '@/components/Background.astro' 3 | import { ButtonContainer } from '@/components/ButtonContainer' 4 | import ErrorPage from '@/components/ErrorPage.astro' 5 | import Footer from '@/components/Footer.astro' 6 | import { ModeToggle } from '@/components/ModeToggle' 7 | import { UserContainer } from '@/components/UserContainer' 8 | import { getConfig } from '@/lib/config' 9 | import Layout from '../layouts/Layout.astro' 10 | 11 | import '../styles/global.css' 12 | 13 | // Load configuration 14 | const config = await getConfig() 15 | 16 | --- 17 | 18 | 21 | 22 | 23 | { 24 | !config 25 | ? 26 | : ( 27 |
28 | 31 | 32 |
33 | 34 |
35 | 36 |
37 |
38 | 39 |
40 | 41 |
42 | 43 |
44 |
45 | 46 |
47 |
48 | ) 49 | } 50 | 51 | -------------------------------------------------------------------------------- /src/components/backgrounds/custom-background.tsx: -------------------------------------------------------------------------------- 1 | import type { CSSProperties } from 'react' 2 | 3 | interface CustomBackgroundProps { 4 | customCSS?: Record 5 | preset?: { 6 | type: 'image' | 'color' | 'gradient' 7 | image?: string 8 | color?: string 9 | gradient?: { 10 | type: 'linear' | 'radial' 11 | colors: string[] 12 | angle?: number 13 | } 14 | } 15 | } 16 | 17 | export function CustomBackground({ customCSS, preset }: CustomBackgroundProps) { 18 | if (customCSS) { 19 | return ( 20 |
24 | ) 25 | } 26 | 27 | if (preset) { 28 | let style: CSSProperties = {} 29 | 30 | switch (preset.type) { 31 | case 'image': 32 | style = { 33 | backgroundImage: `url("${preset.image}")`, 34 | backgroundSize: 'cover', 35 | backgroundPosition: 'center', 36 | } 37 | break 38 | case 'color': 39 | style = { 40 | backgroundColor: preset.color, 41 | } 42 | break 43 | case 'gradient': 44 | if (preset.gradient) { 45 | const { type, colors, angle } = preset.gradient 46 | const gradientType = type === 'linear' 47 | ? `linear-gradient(${angle || 0}deg, ${colors.join(', ')})` 48 | : `radial-gradient(circle, ${colors.join(', ')})` 49 | style = { 50 | backgroundImage: gradientType, 51 | } 52 | } 53 | break 54 | } 55 | 56 | return ( 57 |
61 | ) 62 | } 63 | 64 | return null 65 | } 66 | -------------------------------------------------------------------------------- /src/components/backgrounds/grid-pattern.tsx: -------------------------------------------------------------------------------- 1 | import { useId } from 'react' 2 | 3 | import { cn } from '@/lib/utils' 4 | 5 | interface GridPatternProps extends React.SVGProps { 6 | width?: number 7 | height?: number 8 | x?: number 9 | y?: number 10 | squares?: Array<[x: number, y: number]> 11 | strokeDasharray?: string 12 | className?: string 13 | [key: string]: unknown 14 | } 15 | 16 | export function GridPattern({ 17 | width = 40, 18 | height = 40, 19 | x = -1, 20 | y = -1, 21 | strokeDasharray = '0', 22 | squares, 23 | className, 24 | ...props 25 | }: GridPatternProps) { 26 | const id = useId() 27 | 28 | return ( 29 | 69 | ) 70 | } 71 | -------------------------------------------------------------------------------- /src/components/ButtonContainer.tsx: -------------------------------------------------------------------------------- 1 | import type { ParsedConfig } from '@/types' 2 | import { Button } from '@/components/ui/button' 3 | import { Icon } from '@/components/ui/icon' 4 | 5 | export function ButtonContainer({ config }: { config: ParsedConfig }) { 6 | return ( 7 | 47 | ) 48 | } 49 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "shako", 3 | "type": "module", 4 | "version": "0.6.0", 5 | "packageManager": "bun@1.3.0", 6 | "scripts": { 7 | "dev": "astro dev", 8 | "start": "astro dev", 9 | "check": "astro check", 10 | "build": "astro check && astro build", 11 | "preview": "astro preview", 12 | "astro": "astro", 13 | "lint": "eslint .", 14 | "lint:fix": "eslint . --fix", 15 | "up": "taze major -I" 16 | }, 17 | "dependencies": { 18 | "@astrojs/react": "^4.4.2", 19 | "@fontsource/geist-mono": "^5.2.7", 20 | "@fontsource/geist-sans": "^5.2.5", 21 | "@iconify-json/simple-icons": "^1.2.61", 22 | "@iconify/react": "^6.0.2", 23 | "@tailwindcss/vite": "^4.1.17", 24 | "astro": "^5.16.3", 25 | "class-variance-authority": "^0.7.1", 26 | "clsx": "^2.1.1", 27 | "lucide-react": "^0.561.0", 28 | "motion": "^12.23.25", 29 | "radix-ui": "^1.4.3", 30 | "react": "^19.2.0", 31 | "react-dom": "^19.2.0", 32 | "tailwind-merge": "^3.4.0", 33 | "tailwindcss": "^4.1.17", 34 | "tailwindcss-animate": "^1.0.7", 35 | "use-lanyard": "^1.7.0" 36 | }, 37 | "devDependencies": { 38 | "@antfu/eslint-config": "6.7.1", 39 | "@astrojs/check": "0.9.6", 40 | "@astrojs/ts-plugin": "1.10.6", 41 | "@eslint-react/eslint-plugin": "2.3.13", 42 | "@playform/compress": "0.2.0", 43 | "@types/bun": "1.3.4", 44 | "@types/react": "19.2.7", 45 | "@types/react-dom": "19.2.3", 46 | "astro-eslint-parser": "1.2.2", 47 | "c12": "3.3.2", 48 | "eslint": "9.39.2", 49 | "eslint-plugin-astro": "1.5.0", 50 | "eslint-plugin-format": "1.1.0", 51 | "eslint-plugin-react-hooks": "7.0.1", 52 | "eslint-plugin-react-refresh": "0.4.24", 53 | "eslint-plugin-tailwindcss": "4.0.0-beta.0", 54 | "prettier": "3.7.4", 55 | "prettier-plugin-astro": "0.14.1", 56 | "taze": "19.9.2", 57 | "tw-animate-css": "1.4.0", 58 | "typescript": "5.9.3", 59 | "valibot": "1.2.0", 60 | "wrangler": "4.55.0" 61 | }, 62 | "trustedDependencies": [ 63 | "@tailwindcss/oxide", 64 | "esbuild", 65 | "sharp", 66 | "unrs-resolver", 67 | "workerd" 68 | ] 69 | } 70 | -------------------------------------------------------------------------------- /src/types.ts: -------------------------------------------------------------------------------- 1 | import type { Types } from '@prequist/lanyard' 2 | import * as v from 'valibot' 3 | 4 | export const configSchema = v.object({ 5 | page: v.object({ 6 | title: v.optional(v.string(), 'Shako'), 7 | footer: v.optional(v.union([v.boolean(), v.string()]), true), 8 | borderRadius: v.optional(v.number(), 0.625), 9 | background: v.optional(v.union([ 10 | v.picklist(['dot', 'grid', 'dashed-grid', 'flickering-grid', 'animated-grid', 'none']), 11 | v.object({ 12 | type: v.picklist(['image', 'color', 'gradient', 'custom']), 13 | value: v.union([v.string(), v.object({ 14 | type: v.picklist(['linear', 'radial']), 15 | colors: v.array(v.string()), 16 | direction: v.number(), 17 | }), v.record(v.string(), v.string())]), 18 | }), 19 | ]), 'none'), 20 | redirects: v.optional(v.record(v.string(), v.string()), {}), 21 | }), 22 | user: v.object({ 23 | name: v.optional(v.string()), 24 | avatar: v.optional(v.pipe(v.string(), v.url())), 25 | bio: v.optional(v.string()), 26 | discordId: v.custom((value) => { 27 | const snowflakeRegex = /^\d{17,19}$/ 28 | return typeof value === 'string' && snowflakeRegex.test(value) 29 | }), 30 | }), 31 | api: v.optional(v.object({ 32 | lanyardUrl: v.optional(v.pipe(v.string(), v.url()), 'https://api.lanyard.rest/'), 33 | }), {}), 34 | links: v.object({ 35 | social: v.optional(v.array(v.object({ 36 | icon: v.string(), 37 | url: v.pipe(v.string(), v.url()), 38 | style: v.optional(v.picklist(['default', 'destructive', 'outline', 'secondary', 'ghost', 'link']), 'secondary'), 39 | })), []), 40 | primary: v.optional(v.array(v.object({ 41 | label: v.string(), 42 | icon: v.string(), 43 | url: v.pipe(v.string(), v.url()), 44 | style: v.optional(v.picklist(['default', 'destructive', 'outline', 'secondary', 'ghost', 'link']), 'outline'), 45 | size: v.optional(v.picklist(['default', 'sm', 'lg', 'xl']), 'xl'), 46 | })), []), 47 | }), 48 | }) 49 | 50 | export type Config = v.InferInput 51 | export type ParsedConfig = v.InferOutput 52 | -------------------------------------------------------------------------------- /shako.config.ts: -------------------------------------------------------------------------------- 1 | import type { Config } from '@/types' 2 | 3 | const config: Config = { 4 | page: { 5 | title: 'Shako - Keksi', 6 | footer: true, 7 | borderRadius: 0.5, 8 | background: 'flickering-grid', 9 | // redirects: { 10 | // 'discord': 'https://discord.gg/keksi', 11 | // }, 12 | }, 13 | user: { 14 | //* Setting name and avatar will override the Lanyard user data 15 | // name: 'Keksi', 16 | // avatar: 'https://avatars.githubusercontent.com/u/28254289?v=4', 17 | // bio: 'Software Engineer', 18 | discordId: '527147599942385674', 19 | }, 20 | api: { 21 | //* Lanyard API URL (default: https://api.lanyard.rest/) 22 | lanyardUrl: 'https://api.lanyard.rest/', 23 | }, 24 | links: { 25 | //* Social links (small buttons on the top) 26 | social: [ 27 | { 28 | icon: 'patreon', 29 | url: 'https://patreon.com/keksi', 30 | }, 31 | { 32 | icon: 'buymeacoffee', 33 | url: 'https://www.buymeacoffee.com/keksi', 34 | }, 35 | { 36 | icon: 'githubsponsors', 37 | url: 'https://github.com/sponsors/keksiqc', 38 | }, 39 | ], 40 | //* Primary links (big buttons) 41 | primary: [ 42 | { 43 | label: 'GitHub', 44 | icon: 'github', 45 | url: 'https://github.com/keksiqc', 46 | }, 47 | { 48 | label: 'Discord', 49 | icon: 'discord', 50 | url: 'https://discord.com/users/527147599942385674', 51 | }, 52 | { 53 | label: 'Twitter', 54 | icon: 'x', 55 | url: 'https://x.com/keksiqc', 56 | }, 57 | { 58 | label: 'Bluesky', 59 | icon: 'bluesky', 60 | url: 'https://bsky.app/profile/keksi.dev', 61 | }, 62 | { 63 | label: 'Steam', 64 | icon: 'steam', 65 | url: 'https://steamcommunity.com/id/keksiqc', 66 | }, 67 | { 68 | label: 'AniList', 69 | icon: 'anilist', 70 | url: 'https://anilist.co/user/keksi', 71 | }, 72 | { 73 | label: 'Simkl', 74 | icon: 'simkl', 75 | url: 'https://simkl.com/7534025', 76 | }, 77 | ], 78 | }, 79 | } 80 | 81 | export default config 82 | -------------------------------------------------------------------------------- /.github/workflows/docker.yaml: -------------------------------------------------------------------------------- 1 | name: Docker Build and Publish 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | tags: 8 | - 'v*' 9 | pull_request: 10 | branches: 11 | - main 12 | workflow_dispatch: 13 | 14 | jobs: 15 | build: 16 | runs-on: ubuntu-latest 17 | strategy: 18 | fail-fast: false 19 | permissions: 20 | contents: read 21 | packages: write 22 | 23 | steps: 24 | - name: Checkout 25 | uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6 26 | 27 | - name: Set up QEMU 28 | uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # v3 29 | 30 | - name: Set up Docker Buildx 31 | uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3 32 | 33 | - name: Docker metadata 34 | id: metadata 35 | uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # v5 36 | with: 37 | images: ghcr.io/${{ github.repository }} 38 | tags: | 39 | type=raw,value=latest,enable={{is_default_branch}} 40 | type=ref,event=branch 41 | type=semver,pattern={{version}} 42 | type=semver,pattern={{major}}.{{minor}} 43 | type=semver,pattern={{major}} 44 | type=raw,value={{sha}},enable=${{ github.ref_type != 'tag' }} 45 | 46 | # https://github.com/docker/login-action 47 | - name: Login to Docker Hub 48 | if: github.event_name != 'pull_request' 49 | uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3 50 | with: 51 | username: ${{ github.actor }} 52 | password: ${{ secrets.GITHUB_TOKEN }} 53 | registry: ghcr.io 54 | 55 | # Build and push Docker image with Buildx (don't push on PR) 56 | # https://github.com/docker/build-push-action 57 | - name: Build and push Docker image 58 | uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6 59 | with: 60 | context: . 61 | file: ./docker/Dockerfile 62 | platforms: linux/amd64,linux/arm64 63 | push: ${{ github.event_name != 'pull_request' }} 64 | tags: ${{ steps.metadata.outputs.tags }} 65 | labels: ${{ steps.metadata.outputs.labels }} 66 | cache-from: type=gha 67 | cache-to: type=gha,mode=max 68 | -------------------------------------------------------------------------------- /src/components/ui/button.tsx: -------------------------------------------------------------------------------- 1 | import type { VariantProps } from 'class-variance-authority' 2 | import { cva } from 'class-variance-authority' 3 | import { Slot as SlotPrimitive } from 'radix-ui' 4 | import * as React from 'react' 5 | 6 | import { cn } from '@/lib/utils' 7 | 8 | const buttonVariants = cva( 9 | 'inline-flex shrink-0 items-center justify-center gap-2 rounded-md text-sm font-medium whitespace-nowrap transition-all outline-none focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50 disabled:pointer-events-none disabled:opacity-50 aria-invalid:border-destructive aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*="size-"])]:size-4', 10 | { 11 | variants: { 12 | variant: { 13 | default: 14 | 'bg-primary text-primary-foreground shadow-xs hover:bg-primary/90', 15 | destructive: 16 | 'bg-destructive text-white shadow-xs hover:bg-destructive/90 focus-visible:ring-destructive/20 dark:bg-destructive/60 dark:focus-visible:ring-destructive/40', 17 | outline: 18 | 'border bg-background shadow-xs hover:bg-accent hover:text-accent-foreground dark:border-input dark:bg-input/30 dark:hover:bg-input/50', 19 | secondary: 20 | 'bg-secondary text-secondary-foreground shadow-xs hover:bg-secondary/80', 21 | ghost: 22 | 'hover:bg-accent hover:text-accent-foreground dark:hover:bg-accent/50', 23 | link: 'text-primary underline-offset-4 hover:underline', 24 | }, 25 | size: { 26 | default: 'h-9 px-4 py-2 has-[>svg]:px-3', 27 | sm: 'h-8 gap-1.5 rounded-md px-3 has-[>svg]:px-2.5', 28 | lg: 'h-10 rounded-md px-6 has-[>svg]:px-4', 29 | xl: 'h-14 rounded-lg px-8 has-[>svg]:px-6', 30 | icon: 'size-10', 31 | }, 32 | }, 33 | defaultVariants: { 34 | variant: 'default', 35 | size: 'default', 36 | }, 37 | }, 38 | ) 39 | 40 | function Button({ 41 | className, 42 | variant, 43 | size, 44 | asChild = false, 45 | ...props 46 | }: React.ComponentProps<'button'> 47 | & VariantProps & { 48 | asChild?: boolean 49 | }) { 50 | const Comp = asChild ? SlotPrimitive.Slot : 'button' 51 | 52 | return ( 53 | 58 | ) 59 | } 60 | 61 | export { Button } 62 | -------------------------------------------------------------------------------- /src/components/Background.astro: -------------------------------------------------------------------------------- 1 | --- 2 | import type { Config } from '@/types' 3 | import { AnimatedGrid } from '@/components/backgrounds/animated-grid' 4 | import { CustomBackground } from '@/components/backgrounds/custom-background' 5 | import { DotPattern } from '@/components/backgrounds/dot-pattern' 6 | import { FlickeringGrid } from '@/components/backgrounds/flickering-grid' 7 | import { GridPattern } from '@/components/backgrounds/grid-pattern' 8 | 9 | export interface Props { 10 | background?: Config['page']['background'] 11 | } 12 | 13 | const { background } = Astro.props 14 | 15 | // Early return for no background 16 | if (!background || background === 'none') { 17 | return null 18 | } 19 | 20 | // Helper functions for custom backgrounds 21 | function getImageProps(value: string) { 22 | return { preset: { type: 'image' as const, image: value } } 23 | } 24 | 25 | function getColorProps(value: string) { 26 | return { preset: { type: 'color' as const, color: value } } 27 | } 28 | 29 | function getGradientProps(value: { type: 'linear' | 'radial', colors: string[], direction: number }) { 30 | return { 31 | preset: { 32 | type: 'gradient' as const, 33 | gradient: { 34 | type: value.type, 35 | colors: value.colors, 36 | angle: value.direction, 37 | }, 38 | }, 39 | } 40 | } 41 | 42 | function getCustomProps(value: Record) { 43 | return { customCSS: value } 44 | } 45 | --- 46 | 47 | {/* Simple backgrounds */} 48 | {background === 'dot' && } 49 | {background === 'grid' && } 50 | {background === 'dashed-grid' && } 51 | {background === 'flickering-grid' && } 52 | {background === 'animated-grid' && } 53 | 54 | {/* Custom backgrounds */} 55 | {typeof background === 'object' && background.type === 'image' && ( 56 | 57 | )} 58 | {typeof background === 'object' && background.type === 'color' && ( 59 | 60 | )} 61 | {typeof background === 'object' && background.type === 'gradient' && ( 62 | 63 | )} 64 | {typeof background === 'object' && background.type === 'custom' && ( 65 | )} /> 66 | )} 67 | -------------------------------------------------------------------------------- /src/components/UserContainer.tsx: -------------------------------------------------------------------------------- 1 | import type { Types } from '@prequist/lanyard' 2 | import type { ParsedConfig } from '@/types' 3 | import { memo } from 'react' 4 | import { useLanyard } from 'use-lanyard' 5 | import { Avatar, AvatarFallback, AvatarImage } from '@/components/ui/avatar' 6 | import { Skeleton } from '@/components/ui/skeleton' 7 | 8 | function UserContainerBase({ config }: { config: ParsedConfig | null }) { 9 | // Only call the hook when we have a valid discordId 10 | const { data, error, isLoading } = useLanyard( 11 | config?.user?.discordId as Types.Snowflake, 12 | { 13 | api: { 14 | hostname: config?.api?.lanyardUrl?.replace(/^https?:\/\//, '').replace(/\/$/, '') || 'api.lanyard.rest', 15 | secure: true, 16 | }, 17 | }, 18 | ) 19 | 20 | // Determine user info - prefer config values, fallback to Lanyard data 21 | const userName = config?.user?.name || data?.discord_user?.global_name || data?.discord_user?.username 22 | 23 | // Construct avatar URL properly 24 | let avatarUrl = config?.user?.avatar 25 | if (!avatarUrl && data?.discord_user?.avatar) { 26 | avatarUrl = `https://cdn.discordapp.com/avatars/${data.discord_user.id}/${data.discord_user.avatar}.${data.discord_user.avatar.startsWith('a_') ? 'gif' : 'png'}?size=256` 27 | } 28 | 29 | const description = config?.user?.bio 30 | 31 | // Show error if there's an error and no fallback data 32 | if (error && !userName && !avatarUrl) { 33 | return ( 34 |
35 | 36 | ! 37 | 38 |

39 | {`Failed to load user data: ${error.message}`} 40 |

41 |
42 | ) 43 | } 44 | 45 | // Show loading state while fetching data (but only if no fallback config data exists) 46 | if (isLoading && !userName && !avatarUrl && !config?.user?.name) { 47 | return ( 48 |
49 | 50 | 51 | {description && } 52 |
53 | ) 54 | } 55 | 56 | // Show user data (either from config or fetched from Discord) 57 | return ( 58 |
59 | 60 | 61 | 62 | {userName?.[0]?.toUpperCase() || 'U'} 63 | 64 | 65 |

66 | {userName || 'User'} 67 |

68 | {description &&

{description}

} 69 |
70 | ) 71 | } 72 | 73 | // Memoize the component to prevent unnecessary re-renders 74 | export const UserContainer = memo(UserContainerBase) 75 | -------------------------------------------------------------------------------- /src/styles/global.css: -------------------------------------------------------------------------------- 1 | @import "tailwindcss"; 2 | 3 | @custom-variant dark (&:is(.dark *)); 4 | 5 | @theme inline { 6 | --radius-sm: calc(var(--radius) - 4px); 7 | --radius-md: calc(var(--radius) - 2px); 8 | --radius-lg: var(--radius); 9 | --radius-xl: calc(var(--radius) + 4px); 10 | --color-background: var(--background); 11 | --color-foreground: var(--foreground); 12 | --color-card: var(--card); 13 | --color-card-foreground: var(--card-foreground); 14 | --color-popover: var(--popover); 15 | --color-popover-foreground: var(--popover-foreground); 16 | --color-primary: var(--primary); 17 | --color-primary-foreground: var(--primary-foreground); 18 | --color-secondary: var(--secondary); 19 | --color-secondary-foreground: var(--secondary-foreground); 20 | --color-muted: var(--muted); 21 | --color-muted-foreground: var(--muted-foreground); 22 | --color-accent: var(--accent); 23 | --color-accent-foreground: var(--accent-foreground); 24 | --color-destructive: var(--destructive); 25 | --color-border: var(--border); 26 | --color-input: var(--input); 27 | --color-ring: var(--ring); 28 | --color-chart-1: var(--chart-1); 29 | --color-chart-2: var(--chart-2); 30 | --color-chart-3: var(--chart-3); 31 | --color-chart-4: var(--chart-4); 32 | --color-chart-5: var(--chart-5); 33 | --color-sidebar: var(--sidebar); 34 | --color-sidebar-foreground: var(--sidebar-foreground); 35 | --color-sidebar-primary: var(--sidebar-primary); 36 | --color-sidebar-primary-foreground: var(--sidebar-primary-foreground); 37 | --color-sidebar-accent: var(--sidebar-accent); 38 | --color-sidebar-accent-foreground: var(--sidebar-accent-foreground); 39 | --color-sidebar-border: var(--sidebar-border); 40 | --color-sidebar-ring: var(--sidebar-ring); 41 | } 42 | 43 | :root { 44 | --radius: 0.625rem; 45 | --background: oklch(1 0 0); 46 | --foreground: oklch(0.145 0 0); 47 | --card: oklch(1 0 0); 48 | --card-foreground: oklch(0.145 0 0); 49 | --popover: oklch(1 0 0); 50 | --popover-foreground: oklch(0.145 0 0); 51 | --primary: oklch(0.205 0 0); 52 | --primary-foreground: oklch(0.985 0 0); 53 | --secondary: oklch(0.97 0 0); 54 | --secondary-foreground: oklch(0.205 0 0); 55 | --muted: oklch(0.97 0 0); 56 | --muted-foreground: oklch(0.556 0 0); 57 | --accent: oklch(0.97 0 0); 58 | --accent-foreground: oklch(0.205 0 0); 59 | --destructive: oklch(0.577 0.245 27.325); 60 | --border: oklch(0.922 0 0); 61 | --input: oklch(0.922 0 0); 62 | --ring: oklch(0.708 0 0); 63 | --chart-1: oklch(0.646 0.222 41.116); 64 | --chart-2: oklch(0.6 0.118 184.704); 65 | --chart-3: oklch(0.398 0.07 227.392); 66 | --chart-4: oklch(0.828 0.189 84.429); 67 | --chart-5: oklch(0.769 0.188 70.08); 68 | --sidebar: oklch(0.985 0 0); 69 | --sidebar-foreground: oklch(0.145 0 0); 70 | --sidebar-primary: oklch(0.205 0 0); 71 | --sidebar-primary-foreground: oklch(0.985 0 0); 72 | --sidebar-accent: oklch(0.97 0 0); 73 | --sidebar-accent-foreground: oklch(0.205 0 0); 74 | --sidebar-border: oklch(0.922 0 0); 75 | --sidebar-ring: oklch(0.708 0 0); 76 | } 77 | 78 | .dark { 79 | --background: oklch(0.145 0 0); 80 | --foreground: oklch(0.985 0 0); 81 | --card: oklch(0.205 0 0); 82 | --card-foreground: oklch(0.985 0 0); 83 | --popover: oklch(0.205 0 0); 84 | --popover-foreground: oklch(0.985 0 0); 85 | --primary: oklch(0.922 0 0); 86 | --primary-foreground: oklch(0.205 0 0); 87 | --secondary: oklch(0.269 0 0); 88 | --secondary-foreground: oklch(0.985 0 0); 89 | --muted: oklch(0.269 0 0); 90 | --muted-foreground: oklch(0.708 0 0); 91 | --accent: oklch(0.269 0 0); 92 | --accent-foreground: oklch(0.985 0 0); 93 | --destructive: oklch(0.704 0.191 22.216); 94 | --border: oklch(1 0 0 / 10%); 95 | --input: oklch(1 0 0 / 15%); 96 | --ring: oklch(0.556 0 0); 97 | --chart-1: oklch(0.488 0.243 264.376); 98 | --chart-2: oklch(0.696 0.17 162.48); 99 | --chart-3: oklch(0.769 0.188 70.08); 100 | --chart-4: oklch(0.627 0.265 303.9); 101 | --chart-5: oklch(0.645 0.246 16.439); 102 | --sidebar: oklch(0.205 0 0); 103 | --sidebar-foreground: oklch(0.985 0 0); 104 | --sidebar-primary: oklch(0.488 0.243 264.376); 105 | --sidebar-primary-foreground: oklch(0.985 0 0); 106 | --sidebar-accent: oklch(0.269 0 0); 107 | --sidebar-accent-foreground: oklch(0.985 0 0); 108 | --sidebar-border: oklch(1 0 0 / 10%); 109 | --sidebar-ring: oklch(0.556 0 0); 110 | } 111 | 112 | @layer base { 113 | * { 114 | @apply border-border outline-ring/50; 115 | } 116 | body { 117 | @apply bg-background text-foreground; 118 | } 119 | } 120 | 121 | @layer utilities { 122 | html { 123 | font-family: 'Geist Sans', system-ui, sans-serif; 124 | } 125 | a { 126 | font-family: 'Geist Mono', monospace; 127 | } 128 | } 129 | -------------------------------------------------------------------------------- /src/components/backgrounds/animated-grid.tsx: -------------------------------------------------------------------------------- 1 | 'use client' 2 | 3 | import type { 4 | ComponentPropsWithoutRef, 5 | } from 'react' 6 | import { motion } from 'motion/react' 7 | 8 | import { 9 | useCallback, 10 | useEffect, 11 | useId, 12 | useRef, 13 | useState, 14 | } from 'react' 15 | import { cn } from '@/lib/utils' 16 | 17 | interface Square { 18 | id: string 19 | pos: [number, number] 20 | } 21 | 22 | export interface AnimatedGridPatternProps 23 | extends ComponentPropsWithoutRef<'svg'> { 24 | width?: number 25 | height?: number 26 | x?: number 27 | y?: number 28 | strokeDasharray?: any 29 | numSquares?: number 30 | maxOpacity?: number 31 | duration?: number 32 | repeatDelay?: number 33 | } 34 | 35 | export function AnimatedGrid({ 36 | width = 40, 37 | height = 40, 38 | x = -1, 39 | y = -1, 40 | strokeDasharray = 0, 41 | numSquares = 50, 42 | className, 43 | maxOpacity = 0.1, 44 | duration = 4, 45 | ...props 46 | }: AnimatedGridPatternProps) { 47 | const id = useId() 48 | const containerRef = useRef(null) 49 | const [dimensions, setDimensions] = useState({ width: 0, height: 0 }) 50 | 51 | const getPos = useCallback((): [number, number] => { 52 | return [ 53 | Math.floor((Math.random() * dimensions.width) / width), 54 | Math.floor((Math.random() * dimensions.height) / height), 55 | ] 56 | }, [dimensions.width, dimensions.height, width, height]) 57 | 58 | // Adjust the generateSquares function to return objects with an id, x, and y 59 | const generateSquares = useCallback((count: number): Square[] => { 60 | return Array.from({ length: count }, (_, i) => ({ 61 | id: `${id}-square-${i}`, 62 | pos: getPos(), 63 | })) 64 | }, [getPos, id]) 65 | 66 | const [squares, setSquares] = useState(() => generateSquares(numSquares)) 67 | 68 | // Function to update a single square's position 69 | const updateSquarePosition = useCallback((id: string) => { 70 | setSquares((currentSquares: Square[]) => 71 | currentSquares.map((sq: Square) => 72 | sq.id === id 73 | ? { 74 | ...sq, 75 | pos: getPos(), 76 | } 77 | : sq, 78 | ), 79 | ) 80 | }, [getPos]) 81 | 82 | // Update squares to animate in 83 | useEffect(() => { 84 | if (dimensions.width && dimensions.height) { 85 | // TODO: Fix this 86 | // eslint-disable-next-line react-hooks/set-state-in-effect 87 | setSquares(generateSquares(numSquares)) 88 | } 89 | }, [dimensions, numSquares, generateSquares]) 90 | 91 | // Resize observer to update container dimensions 92 | useEffect(() => { 93 | const container = containerRef.current 94 | const resizeObserver = new ResizeObserver((entries) => { 95 | for (const entry of entries) { 96 | setDimensions({ 97 | width: entry.contentRect.width, 98 | height: entry.contentRect.height, 99 | }) 100 | } 101 | }) 102 | 103 | if (container) { 104 | resizeObserver.observe(container) 105 | } 106 | 107 | return () => { 108 | resizeObserver.disconnect() 109 | } 110 | }, []) 111 | 112 | return ( 113 | 162 | ) 163 | } 164 | -------------------------------------------------------------------------------- /src/components/backgrounds/flickering-grid.tsx: -------------------------------------------------------------------------------- 1 | 'use client' 2 | 3 | import React, { 4 | useCallback, 5 | useEffect, 6 | useMemo, 7 | useRef, 8 | useState, 9 | } from 'react' 10 | import { cn } from '@/lib/utils' 11 | 12 | interface FlickeringGridProps extends React.HTMLAttributes { 13 | squareSize?: number 14 | gridGap?: number 15 | flickerChance?: number 16 | color?: string 17 | width?: number 18 | height?: number 19 | className?: string 20 | maxOpacity?: number 21 | } 22 | 23 | export const FlickeringGrid: React.FC = ({ 24 | squareSize = 4, 25 | gridGap = 6, 26 | flickerChance = 0.3, 27 | color = 'rgb(0, 0, 0)', 28 | width, 29 | height, 30 | className, 31 | maxOpacity = 0.3, 32 | ...props 33 | }) => { 34 | const canvasRef = useRef(null) 35 | const containerRef = useRef(null) 36 | const [isInView, setIsInView] = useState(false) 37 | const [canvasSize, setCanvasSize] = useState({ width: 0, height: 0 }) 38 | 39 | const memoizedColor = useMemo(() => { 40 | const toRGBA = (color: string) => { 41 | if (typeof window === 'undefined') { 42 | return `rgba(0, 0, 0,` 43 | } 44 | const canvas = document.createElement('canvas') 45 | canvas.width = canvas.height = 1 46 | const ctx = canvas.getContext('2d') 47 | if (!ctx) 48 | return 'rgba(255, 0, 0,' 49 | ctx.fillStyle = color 50 | ctx.fillRect(0, 0, 1, 1) 51 | const [r, g, b] = Array.from(ctx.getImageData(0, 0, 1, 1).data) 52 | return `rgba(${r}, ${g}, ${b},` 53 | } 54 | return toRGBA(color) 55 | }, [color]) 56 | 57 | const setupCanvas = useCallback( 58 | (canvas: HTMLCanvasElement, width: number, height: number) => { 59 | const dpr = window.devicePixelRatio || 1 60 | canvas.width = width * dpr 61 | canvas.height = height * dpr 62 | canvas.style.width = `${width}px` 63 | canvas.style.height = `${height}px` 64 | const cols = Math.floor(width / (squareSize + gridGap)) 65 | const rows = Math.floor(height / (squareSize + gridGap)) 66 | 67 | const squares = new Float32Array(cols * rows) 68 | for (let i = 0; i < squares.length; i++) { 69 | squares[i] = Math.random() * maxOpacity 70 | } 71 | 72 | return { cols, rows, squares, dpr } 73 | }, 74 | [squareSize, gridGap, maxOpacity], 75 | ) 76 | 77 | const updateSquares = useCallback( 78 | (squares: Float32Array, deltaTime: number) => { 79 | for (let i = 0; i < squares.length; i++) { 80 | if (Math.random() < flickerChance * deltaTime) { 81 | squares[i] = Math.random() * maxOpacity 82 | } 83 | } 84 | }, 85 | [flickerChance, maxOpacity], 86 | ) 87 | 88 | const drawGrid = useCallback( 89 | ( 90 | ctx: CanvasRenderingContext2D, 91 | width: number, 92 | height: number, 93 | cols: number, 94 | rows: number, 95 | squares: Float32Array, 96 | dpr: number, 97 | ) => { 98 | ctx.clearRect(0, 0, width, height) 99 | ctx.fillStyle = 'transparent' 100 | ctx.fillRect(0, 0, width, height) 101 | 102 | for (let i = 0; i < cols; i++) { 103 | for (let j = 0; j < rows; j++) { 104 | const opacity = squares[i * rows + j] 105 | ctx.fillStyle = `${memoizedColor}${opacity})` 106 | ctx.fillRect( 107 | i * (squareSize + gridGap) * dpr, 108 | j * (squareSize + gridGap) * dpr, 109 | squareSize * dpr, 110 | squareSize * dpr, 111 | ) 112 | } 113 | } 114 | }, 115 | [memoizedColor, squareSize, gridGap], 116 | ) 117 | 118 | useEffect(() => { 119 | const canvas = canvasRef.current 120 | const container = containerRef.current 121 | if (!canvas || !container) 122 | return 123 | 124 | const ctx = canvas.getContext('2d') 125 | if (!ctx) 126 | return 127 | 128 | let animationFrameId: number 129 | let gridParams: ReturnType 130 | 131 | const updateCanvasSize = () => { 132 | const newWidth = width || container.clientWidth 133 | const newHeight = height || container.clientHeight 134 | setCanvasSize({ width: newWidth, height: newHeight }) 135 | gridParams = setupCanvas(canvas, newWidth, newHeight) 136 | } 137 | 138 | updateCanvasSize() 139 | 140 | let lastTime = 0 141 | const animate = (time: number) => { 142 | if (!isInView) 143 | return 144 | 145 | const deltaTime = (time - lastTime) / 1000 146 | lastTime = time 147 | 148 | updateSquares(gridParams.squares, deltaTime) 149 | drawGrid( 150 | ctx, 151 | canvas.width, 152 | canvas.height, 153 | gridParams.cols, 154 | gridParams.rows, 155 | gridParams.squares, 156 | gridParams.dpr, 157 | ) 158 | animationFrameId = requestAnimationFrame(animate) 159 | } 160 | 161 | const resizeObserver = new ResizeObserver(() => { 162 | updateCanvasSize() 163 | }) 164 | 165 | resizeObserver.observe(container) 166 | 167 | const intersectionObserver = new IntersectionObserver( 168 | ([entry]) => { 169 | setIsInView(entry.isIntersecting) 170 | }, 171 | { threshold: 0 }, 172 | ) 173 | 174 | intersectionObserver.observe(canvas) 175 | 176 | if (isInView) { 177 | animationFrameId = requestAnimationFrame(animate) 178 | } 179 | 180 | return () => { 181 | cancelAnimationFrame(animationFrameId) 182 | resizeObserver.disconnect() 183 | intersectionObserver.disconnect() 184 | } 185 | }, [setupCanvas, updateSquares, drawGrid, width, height, isInView]) 186 | 187 | return ( 188 |
193 | 201 |
202 | ) 203 | } 204 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![Shakō](https://raw.githubusercontent.com/keksiqc/shako/main/.github/assets/banner.png) 2 | 3 | # Shakō 4 | 5 | Shakō: A sleek, modern linktree alternative built with Astro and React. It's designed to be easily customizable, self-hostable, and provides a modern look and feel for showcasing your links. An optional hosted version is available at [keksiqc/shako.me](https://github.com/keksiqc/shako.me). 6 | 7 | [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fkeksiqc%2Fshako&project-name=shako&repository-name=shako) 8 | 9 | [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/keksiqc/shako) 10 | 11 | Key features: 12 | 13 | - **Customizable:** Easily change the appearance and functionality to match your personal brand. 14 | - **Self-hostable:** Deploy your linktree on your own server for complete control. 15 | - **Modern design:** A clean and professional look that stands out. 16 | 17 | ## Tech stack 18 | 19 | - Astro 20 | - React 21 | - Tailwind CSS 22 | - Shadcn/UI 23 | - Lanyard 24 | 25 | ## Quick Start 26 | 27 | ```bash 28 | git clone https://github.com/keksiqc/shako 29 | cd shako 30 | bun install 31 | bun run dev 32 | ``` 33 | 34 | ## Configuration 35 | 36 | All configuration is done through the `shako.config.ts` file. Here's a comprehensive guide to all available options: 37 | 38 | ### Page Configuration 39 | 40 | ```typescript 41 | page: { 42 | title: string, // Page title shown in browser tab 43 | footer: boolean | string, // Show footer (true/false) or custom footer text 44 | borderRadius?: number, // Border radius for UI elements (0-1, where 1 = full radius) 45 | background?: string | object, // Background style (see Background Options below) 46 | redirects?: Record // Redirects for custom domains 47 | } 48 | ``` 49 | 50 | #### Redirects 51 | You can redirect paths to other URLs. 52 | ```typescript 53 | redirects: { 54 | '/discord': 'https://discord.gg/keksi', 55 | } 56 | ``` 57 | 58 | #### Background Options 59 | 60 | You can use predefined backgrounds or create custom ones: 61 | 62 | **Predefined backgrounds:** 63 | - `'dot'` - Dot pattern 64 | - `'grid'` - Grid pattern 65 | - `'dashed-grid'` - Dashed grid pattern 66 | - `'flickering-grid'` - Flickering grid effect 67 | - `'animated-grid'` - Animated grid pattern 68 | - `'none'` - No background pattern 69 | 70 | **Custom backgrounds:** 71 | ```typescript 72 | background: { 73 | type: 'image' | 'color' | 'gradient' | 'custom', 74 | value: string | GradientConfig | Record 75 | } 76 | ``` 77 | 78 | **Gradient example:** 79 | ```typescript 80 | background: { 81 | type: 'gradient', 82 | value: { 83 | type: 'linear' | 'radial', 84 | colors: ['#ff0000', '#00ff00', '#0000ff'], 85 | direction: 45 // degrees for linear gradients 86 | } 87 | } 88 | ``` 89 | 90 | ### User Configuration 91 | 92 | ```typescript 93 | user: { 94 | name?: string, // Display name (overrides Discord username if set) 95 | avatar?: string, // Avatar URL (overrides Discord avatar if set) 96 | bio?: string, // Bio text (overrides Discord status if set) 97 | discordId: string // Required: Your Discord user ID for Lanyard integration 98 | } 99 | ``` 100 | 101 | **Note:** If `name` or `avatar` are not specified, Shakō will automatically fetch this information from Discord via Lanyard. 102 | 103 | ### API Configuration 104 | 105 | ```typescript 106 | api: { 107 | lanyardUrl: string // Lanyard API endpoint (default: 'https://api.lanyard.rest/') 108 | } 109 | ``` 110 | 111 | ### Links Configuration 112 | 113 | #### Social Links 114 | Small icon buttons displayed at the top of the page: 115 | 116 | ```typescript 117 | social?: [ 118 | { 119 | icon: string, // Icon name (see supported icons below) 120 | url: string, // Link URL 121 | style?: 'default' | 'destructive' | 'outline' | 'secondary' | 'ghost' | 'link' 122 | } 123 | ] 124 | ``` 125 | 126 | #### Primary Links 127 | Large featured buttons for main links: 128 | 129 | ```typescript 130 | primary?: [ 131 | { 132 | label: string, // Button text 133 | icon: string, // Icon name 134 | url: string, // Link URL 135 | style?: 'default' | 'destructive' | 'outline' | 'secondary' | 'ghost' | 'link', 136 | size?: 'default' | 'sm' | 'lg' | 'xl' 137 | } 138 | ] 139 | ``` 140 | 141 | ### Supported Icons 142 | 143 | See [Simple Icons](https://simpleicons.org/) for a list of supported icons. 144 | 145 | ### Example Configuration 146 | 147 | ```typescript 148 | import type { Config } from '@/types' 149 | 150 | const config: Config = { 151 | page: { 152 | title: 'My Links - John Doe', 153 | footer: true, 154 | borderRadius: 0.5, 155 | background: 'flickering-grid', 156 | }, 157 | user: { 158 | discordId: '123456789012345678', 159 | // name: 'John Doe', // Optional: Override Discord username 160 | // avatar: 'https://...', // Optional: Override Discord avatar 161 | // bio: 'Software Engineer', // Optional 162 | }, 163 | api: { 164 | lanyardUrl: 'https://api.lanyard.rest/', 165 | }, 166 | links: { 167 | social: [ 168 | { icon: 'github', url: 'https://github.com/johndoe' }, 169 | { icon: 'x', url: 'https://x.com/johndoe' }, 170 | ], 171 | primary: [ 172 | { 173 | label: 'My Portfolio', 174 | icon: 'globe', 175 | url: 'https://johndoe.dev', 176 | style: 'default', 177 | size: 'xl' 178 | }, 179 | { 180 | label: 'Contact Me', 181 | icon: 'mail', 182 | url: 'mailto:john@example.com', 183 | style: 'outline' 184 | } 185 | ], 186 | }, 187 | } 188 | 189 | export default config 190 | ``` 191 | 192 | ## Deployment 193 | 194 | To deploy Shakō: 195 | 196 | 1. Build the project: 197 | ```bash 198 | bun run build 199 | ``` 200 | 201 | 2. Deploy the `dist` directory to your preferred hosting platform. 202 | 203 | Follow the official [Astro deployment guide](https://docs.astro.build/en/guides/deploy/) for platform-specific instructions. 204 | 205 | ## License 206 | 207 | Shakō is licensed under the GPL-3.0 License - see the [LICENSE file](./LICENSE) for details. 208 | 209 | ## Contributing 210 | 211 | Contributions are welcome! Please follow these guidelines: 212 | 213 | - Report bugs by opening an issue 214 | - Suggest new features by opening an issue 215 | - Submit pull requests with improvements 216 | 217 | For major changes, please open an issue first to discuss what you would like to change. 218 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | Shakō - self-hostable link in bio site 635 | Copyright (C) 2024 Keksi 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Shakō Copyright (C) 2024 Keksi 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------