Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 1.27 KB

README.md

File metadata and controls

76 lines (53 loc) · 1.27 KB
Raw

Next.js TypeScript Starter

Included

  • config.ts container site information to be used for seo and schema.org data
  • seo.ts util to generate SEO metadata and schema.org
  • manifest.json for site info
  • classnames util for easily managing classes
  • components/atoms/Button.tsx a button component with variants
  • hooks/useClickOutside hook to check if user clicked outside the element
  • hooks/useModal hook to create modals, which can close with esc

Additional Packages Used

  • Tailwind CSS - for styling(with typography plugin)
  • Framer Motion - for animations
  • Akar Icons - library for rounded icons
  • Sonner - for toast messages
  • use-sound - for using sounds
  • Class Variance Authority - for type-safely managing class names

Available Scripts

Install Dependencies

npm install

Install Git Hooks (won't let you commit if there are any ESLint issues)

npm run prepare

Start Development Server

npm run dev

Lint all the files

npm run lint

Format all files with Prettier

npm run format

Check TypeScript issues

npm run type-check

Build for Production

npm run build

Start Production Server

npm start