Skip to content
Back to search

animate-text

This document explains how to run, build, and maintain the project locally.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/pixel-point-animate-text/badge.svg)](/listings/pixel-point-animate-text)

HTML

<a href="/listings/pixel-point-animate-text"><img src="/api/listings/pixel-point-animate-text/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Run all commands from the project root (this folder):

pnpm install
pnpm dev

The app will be available at `http://localhost:3000`.

If environment variables are required for a specific setup:

cp .env.example .env

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 173 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Project Guide
  2. This document explains how to run, build, and maintain the project locally.
  3. ## Technology Stack
  4. - [Next.js](https://nextjs.org/) - application framework and routing
  5. - [Tailwind CSS](https://tailwindcss.com/) - utility-first styling
  6. - [shadcn/ui](https://ui.shadcn.com/) - reusable UI component patterns built on Radix primitives
  7. ## Requirements
  8. - Node.js 20+
  9. - pnpm 10+
  10. ## Getting Started
  11. Run all commands from the project root (this folder):
  12. ```bash
  13. pnpm install
  14. pnpm dev
  15. ```
  16. The app will be available at `http://localhost:3000`.
  17. If environment variables are required for a specific setup:
  18. ```bash
  19. cp .env.example .env
  20. ```
  21. ## Development Workflow
  22. 1. Start the dev server with `pnpm dev`.
  23. 2. Regenerate the skill and app data when changing the animation catalog:
  24. - `pnpm generate:animate-text-skill`
  25. - `pnpm validate:animate-text-catalog`
  26. 3. Add or update routes in `src/app`.
  27. 4. Build reusable UI in `src/components/ui`.
  28. 5. Build page-specific sections in `src/components/pages/<slug>`
  29. 6. Compose pages from those sections inside route files under `src/app`.
  30. 7. Run quality checks before committing:
  31. - `pnpm lint`
  32. - `pnpm format`
  33. - `pnpm typecheck` (`tsgo --noEmit`)
  34. - `pnpm build`
  35. ## Available Scripts
  36. - `pnpm dev` - start Next.js in development mode
  37. - `pnpm generate:animate-text-skill` - rebuild the installable skill and generated site data from `catalog/text-animations`
  38. - `pnpm validate:animate-text-catalog` - validate canonical catalog inputs and ensure generated outputs are up to date
  39. - `pnpm test:animate-text-skill` - smoke test the generated public skill helper scripts
  40. - `pnpm build` - create a production build
  41. - `pnpm start` - run the production server
  42. - `pnpm lint` - run OXC lint checks
  43. - `pnpm lint:fix` - run OXC lint with auto-fixes
  44. - `pnpm format` - check formatting with Oxfmt
  45. - `pnpm format:fix` - format files with Oxfmt
  46. - `pnpm typecheck` - run TypeScript type checks with tsgo
  47. ## Project Structure
  48. ```text
  49. .
  50. ├─ public/ # static assets served as-is
  51. ├─ catalog/ # canonical source-of-truth data for the text animation library
  52. ├─ skills/ # installable generated skill output
  53. ├─ templates/ # templates used to generate skill documents
  54. ├─ src/
  55. │ ├─ app/ # Next.js App Router (routes, layouts, not-found)
  56. │ ├─ components/
  57. │ │ ├─ ui/ # shared UI primitives
  58. │ │ └─ pages/
  59. │ │ ├─ home/ # components used only by the Home page
  60. │ │ └─ <slug>/ # components used only by one specific page
  61. │ ├─ content/ # markdown content grouped by feature/page
  62. │ ├─ configs/ # app and website configuration
  63. │ ├─ constants/ # static constants
  64. │ ├─ contexts/ # React providers/contexts
  65. │ ├─ hooks/ # reusable React hooks
  66. │ ├─ lib/ # utilities and framework helpers
  67. │ ├─ styles/ # global and feature styles
  68. │ └─ types/ # shared TypeScript types
  69. ├─ scripts/ # repo-maintainer scripts including catalog generation/validation
  70. ├─ next.config.ts # Next.js configuration
  71. ├─ postcss.config.mjs # PostCSS configuration
  72. ├─ tailwind.plugins.mjs # Tailwind plugin setup
  73. ├─ .oxlintrc.json # OXC lint configuration
  74. ├─ .oxfmtrc.json # OXC formatter configuration
  75. └─ package.json
  76. ```
  77. ## Website Config
  78. Website-level settings are defined in `src/configs/website-config.ts`.
  79. Use this config for branding, metadata defaults, and repository links. Common fields:
  80. - `projectName` - project name used in UI and metadata
  81. - `metaThemeColors.light` / `metaThemeColors.dark` - browser theme colors
  82. - `src/app/opengraph-image.tsx` - generated OG/social preview image used for Open Graph and Twitter
  83. - `githubOrg` / `githubRepo` - repository metadata for links/integrations
  84. Example:
  85. ```ts
  86. const config = {
  87. projectName: '<YOUR_PROJECT_NAME>',
  88. metaThemeColors: {
  89. light: '#ffffff',
  90. dark: '#09090b',
  91. },
  92. };
  93. ```
  94. ## Content Directory
  95. Content lives in `src/content` and is organized by folders per section/page type.
  96. Example structure:
  97. ```text
  98. src/content/
  99. ├─ blog/
  100. ├─ docs/
  101. └─ legal/
  102. ```
  103. Rules for this project:
  104. - Use Markdown only (`.md` files).
  105. - Keep content grouped by folder (for example: `docs/`, `blog/`, `legal/`).
  106. - Use nested folders when you need hierarchy inside a section.
  107. ### Documentation (`/docs`) Conventions
  108. For the `/docs` section, this project follows the same page conventions as FumaDocs. Use the official [FumaDocs page conventions](https://www.fumadocs.dev/docs/page-conventions) as the primary reference when creating or editing docs pages.
  109. ## Build and Output
  110. - Run `pnpm build` to generate the production build in `.next/`.
  111. - Run `pnpm start` to serve the compiled build.
  112. - `postbuild` can generate sitemap files and `robots.txt` via `next-sitemap`.
  113. - Generated/runtime directories such as `.next/`, `.turbo/`, and `node_modules/` are not source files.
  114. ## Animate Text Skill
  115. This repository now contains two downstream outputs generated from `catalog/text-animations/`:
  116. - `skills/animate-text/` - the installable public skill for the `skills.sh` ecosystem
  117. - `src/data/text-animations/generated/` - app-facing generated modules used by the website
  118. Canonical editing rules:
  119. - edit `catalog/text-animations/**` by hand
  120. - do not hand-edit `skills/animate-text/**`
  121. - do not hand-edit `src/data/text-animations/generated/**`
  122. Typical maintainer flow:
  123. ```bash
  124. pnpm generate:animate-text-skill
  125. pnpm validate:animate-text-catalog
  126. pnpm test:animate-text-skill
  127. ```
  128. Install form for consumers:
  129. ```bash
  130. npx skills add <owner>/<repo> --skill animate-text
  131. ```

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.