sales-crm README

The project's README from github.com/kargulstudio/sales-crm. As one markdown file: README.md.

Kargul Starter

Next.js 16 + React 19 + Tailwind CSS 4 boilerplate. Read CONVENTIONS.md before writing any component, section, or page — it is the whole spec for how this repo is built.

Getting started

npm install
npm run dev

Open http://localhost:3000.

Script What it does
npm run dev Start the dev server
npm run build Production build
npm run start Serve the production build
npm run lint ESLint
npm run to:avif Convert an image to AVIF and report its inline cost — rule 11
npm run extract:avif Pull the first frame of every .webm under public/ as a poster
npm run frame:rive Render a still from a .riv file for use as its poster

First things to set on a new project

  1. lib/seo.ts — SITE_NAME, SITE_URL, SITE_DESCRIPTION, SITE_ROUTES. Everything in app/robots.ts, app/sitemap.ts, app/llms.txt/route.ts and every page's metadata derives from these (rule 18). Set NEXT_PUBLIC_SITE_URL in the environment to override the URL per deploy.
  2. app/globals.css — match the @layer base type scale and the --padding-section-* tokens to the design before building anything (rules 1 and 3).
  3. app/opengraph-image.jpg — 1200×630, with an opengraph-image.alt.txt beside it.
  4. Fonts — app/layout.tsx ships Inter + a local Inter Display; swap them for the design's typeface.

Docs

File What's in it
CONVENTIONS.md The build rules. Read first.
AGENTS.md Next.js version notes for agents
OPTIMIZATION.md Why Asset's Rive loading is gated behind LCP, with the measurements

sales-crm (kargulstudio/sales-crm)

boilerplate
Searching Database…

What is this?Kargul Starter is a boilerplate for building web projects with Next.js 16, React 19, and Tailwind CSS 4, shipped with a strict set of build conventions.
Is this a ready-made app or a starter template I build on top of?It is a starter template (boilerplate), not a finished app. You clone it and build your own project on top of it, following the rules in CONVENTIONS.md, which acts as the full spec for how components, sections, and pages must be built.
How do I get it running?Run npm run dev to start the dev server, npm run build for a production build, and npm run start to serve that build. npm run lint runs ESLint.
What's it built on?The stack is Next.js 16, React 19, and Tailwind CSS 4, with ESLint configured for linting.
Any catch before I start customizing it?You're expected to read CONVENTIONS.md before writing any component, section, or page — it defines the entire design-system spec (layout tokens, type scale, etc.) that the rest of the repo follows.
What do I need to configure first on a new project?Set SITENAME, SITEURL, SITEDESCRIPTION and SITEROUTES in lib/seo.ts (everything in robots.ts, sitemap.ts and page metadata derives from these), match the type scale and padding tokens in app/globals.css to your design, add a 1200x630 app/opengraph-image.jpg with an alt text file, and swap out the default Inter fonts.
What are the avif and rive npm scripts for?npm run to:avif converts an image to AVIF and reports its inline size cost, npm run extract:avif pulls a poster frame from .webm videos under public/, and npm run frame:rive renders a still poster image from a .riv Rive animation file.
What's in AGENTS.md and OPTIMIZATION.md?AGENTS.md holds Next.js version notes meant for coding agents working in the repo, while OPTIMIZATION.md explains (with measurements) why Rive asset loading is gated behind the page's LCP event.
Size
1.4 MB
Stars
1.7K
Updated
CommitOct 06
Age
14d
Commits · 90 Days