Dashfy Website

Website   •   Demo   •   Extensions   •   Docs   •   Discord   •   Sponsor

Introduction

This repository contains the source for the official Dashfy marketing site, live at dashfy.dev. It is built with Next.js and shadcn/ui, and presents the features, its extensions, the brand kit, and the documentation (served at dashfy.dev/docs).

This is the website repository and is separate from the Dashfy framework, which lives in the monorepo at github.com/dashfy/dashfy.

Tech Stack

• Next.js 16 (App Router, Turbopack dev server)
• React 19 and TypeScript
• Tailwind CSS 4 with shadcn/ui (Radix Nova)
• Fumadocs with MDX for the documentation system (content/docs, rendered at /docs)
• Vercel Analytics, Shiki for code highlighting, OverlayScrollbars, and next-themes

Project Structure

content/docs/     # MDX documentation (fumadocs)
source.config.ts  # fumadocs MDX config
src/app/          # Routes (incl. docs + docs-raw .md routes), metadata, OG images
src/components/   # UI sections, navigation, docs, providers
src/config/       # site, paths, extensions, brand
src/hooks/        # Client hooks
src/lib/          # utils, analytics, jsonld, og, shiki, source, LLM text helpers
src/styles/       # Global styles
src/types/        # Type declarations
scripts/          # clean script
public/brand/     # Brand assets served statically

Components under src/components/ui/ are generated by shadcn/ui and are excluded from the strict ESLint rules.

Getting Started

We recommend running the website locally for development. Follow these steps:

1. Requirements:

• Node.js
• pnpm

2. Clone this repository:

git clone git@github.com:dashfy/dashfy-website.git
cd dashfy-website

3. Install dependencies:

pnpm install

4. Optional — enable Ask AI:

cp .env.example .env.local

Add an OPENAI_API_KEY to .env.local. Without it the docs chat returns 503 and everything else works as normal.

5. Start the development server:

pnpm dev

pnpm dev runs through portless, which starts next dev --turbopack. Open the local URL it prints. To run Next.js directly instead, use pnpm dev:next.

Build and run the production server:

pnpm build
pnpm start

Scripts

Script	Description
dev / dev:next	Start the development server
build / start	Build and run the production server
lint / lint:fix	Run ESLint (optionally with autofix)
format	Format files with Prettier
format:check	Check formatting without writing
typecheck	Type-check the project with tsc
lint:links	Validate internal doc links, cards, and anchors
check:fix	Run format, lint fix, typecheck, and link check
clean	Remove build artifacts

Documentation

The documentation is authored as MDX files in content/docs/ and rendered at dashfy.dev/docs with Fumadocs.

• Every page is also available as markdown by appending .md (e.g. /docs/cli.md), handled by the docs-raw route — handy for AI agents.
• Docs pages include a "Copy Page" action with "Open in ChatGPT / Claude / Cursor / Copilot".
• /llms.txt is a statically generated route that indexes the docs page tree and adds Dashfy-specific sections (src/lib/llmsIndex.ts).
• /llms-full.txt serves every docs page concatenated into a single file.

Ask AI

Docs pages have an "Ask AI" button that answers questions from the documentation only. /api/chat streams from OpenAI with the entire corpus in the system prompt — the same text /llms-full.txt serves, shared through src/lib/llmsFull.ts — so there is no separate search index to keep in sync.

Variable	Required	Description
OPENAI_API_KEY	Yes	Enables the route. When absent, /api/chat returns 503.
OPENAI_MODEL	No	Model id. Defaults to gpt-4o-mini.
UPSTASH_REDIS_REST_URL	No	With the token, switches rate limiting to Upstash Redis.
UPSTASH_REDIS_REST_TOKEN	No	Pairs with the URL. Set both, or neither.

Related Repositories

• dashfy/dashfy — the Dashfy framework monorepo, packages, and demo examples
• dashfy.dev/docs — the documentation (authored in this repo under content/docs/)

Contributing

Contributions are welcome. For issues and pull requests related to the website, use the dashfy/dashfy-website repository. Framework contributions belong in dashfy/dashfy.

Community

Join the community on Dashfy's Discord server to discuss the project, ask questions, or get help.

Join the conversation on X (Twitter) and follow @dashfydev for updates and announcements.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

For AI/LLM agents: https://dashfy.dev/llms.txt