Skip to content

Repository files navigation

Stiches Logo

Stiches

A modern Next.js template with beautiful animations and a comprehensive UI component library.


πŸš€ Tech Stack

πŸ“ Project Structure

stiches/
β”œβ”€β”€ app/                    # Next.js App Router pages
β”‚   β”œβ”€β”€ layout.tsx         # Root layout with providers
β”‚   β”œβ”€β”€ page.tsx           # Home page
β”‚   β”œβ”€β”€ providers.tsx      # Theme and UI providers
β”‚   └── void/              # Void page
β”œβ”€β”€ components/            # React components
β”‚   └── ...
β”œβ”€β”€ config/                # Configuration files
β”‚   β”œβ”€β”€ fonts.ts          # Font definitions
β”‚   └── site.ts           # Site metadata and navigation
β”œβ”€β”€ consts/               # Constants
β”‚   └── primitives.ts     # tailwind variants premitives
β”œβ”€β”€ public/               # Static assets
β”‚   └──...
β”œβ”€β”€ styles/               # Global styles
β”‚   └── globals.css       # Tailwind directives and custom styles
β”œβ”€β”€ types/                # TypeScript type definitions
β”œβ”€β”€ .env.example          # Environment variables template
β”œβ”€β”€ .prettierrc           # Code formatting config
β”œβ”€β”€ eslint.config.mjs     # ESLint configuration
β”œβ”€β”€ next.config.js        # Next.js configuration
β”œβ”€β”€ postcss.config.js     # PostCSS configuration
β”œβ”€β”€ tsconfig.json         # TypeScript configuration
└── tailwind.config.mjs   # Tailwind configuration

✨ Features

  • Motion Animations: Smooth, performant animations with spring physics, hover effects, and keyframe animations
  • React Icons: Access to 50,000+ icons from Heroicons, Font Awesome, Simple Icons, Material Design, and more
  • Tailwind CSS 4: Utility-first styling with custom color scheme, responsive design, and dark mode support
  • Tailwind Variants: Type-safe variant management with predefined design system primitives
  • HeroUI Components: Comprehensive React component library with pre-built, accessible, theme-aware components
  • Theme Support: Dark and light mode with seamless transitions using next-themes
  • Type Safety: Full TypeScript coverage with strict mode
  • Modern Tooling: Bun for fast installs and development

πŸ› οΈ Getting Started

Prerequisites

  • Bun installed on your system

Installation

  1. Create a new project using this template:
bunx create-next-app -e https://github.com/HxX2/stiches
  1. Copy environment variables (optional):
cp .env.example .env
  1. Run the development server:
bun dev
  1. Open http://localhost:3000 in your browser

πŸ“ Available Scripts

  • bun dev - Start development server
  • bun build - Build for production
  • bun start - Start production server
  • bun lint - Run ESLint with auto-fix

🎨 Customization

Colors

The project uses a custom color scheme with secondary (#B10F2E) as the brand color. Modify colors in tailwind.config.mjs.

For comprehensive theme customization, use the HeroUI Theme Builder to generate a complete color palette and design system for your entire team.

Fonts

Fonts are configured in config/fonts.ts. The project uses system fonts with fallbacks.

Animations

The project uses Motion for animations. Here are common patterns:

Basic animation:

import { motion } from "motion/react";

<motion.div animate={{ x: 100, opacity: 1 }} transition={{ duration: 0.5 }}>
  Content
</motion.div>;

See Motion documentation for advanced animations and API reference.

React Icons

To add new icons from the React Icons library:

  1. Import the icon from the desired icon pack:
import { HiSparkles, HiBolt } from "react-icons/hi2"; // Heroicons 2
import { SiGithub, SiDocker } from "react-icons/si"; // Simple Icons
import { FaReact, FaNodeJs } from "react-icons/fa"; // Font Awesome
  1. Use the icon component with optional props:
<HiBolt size={24} className="text-primary" />

See React Icons documentation for the complete icon library.

πŸ“¦ Component Library

The project uses HeroUI v2 components including:

  • Navbar, Button, Card, Input
  • Modal, Dropdown, Tooltip
  • Badge, Avatar, Progress
  • And many more...

See HeroUI documentation for full component list.

πŸ”§ Configuration Files

  • next.config.js - Next.js configuration
  • tailwind.config.mjs - Tailwind CSS customization
  • tsconfig.json - TypeScript compiler options
  • eslint.config.mjs - Linting rules
  • .prettierrc - Code formatting rules

πŸ“„ License

Licensed under the MIT license.

🀝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

πŸ”— Links

About

A modern Next.js template with beautiful animations and a comprehensive UI component library.

Topics

Resources

Stars

8 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages