🚀 Augment Next.js Starter Pack

A modern, elegant starter template for Next.js 15 projects with Shadcn UI components, optimized for use with Augment AI coding assistant. This template provides a solid foundation for building beautiful, responsive web applications with the power of AI assistance.

• Augment - AI coding assistant - Try it for free now!

• Augment Discord Community for Help

• Demo : See this package in action

✨ Features

• 🔥 Next.js 15 - The latest version of Next.js with App Router
• 🎨 Shadcn UI - Beautiful, accessible UI components
• 🌙 Dark Mode - Elegant light and dark mode support
• 📱 Responsive Design - Looks great on all devices
• 🧩 Component Showcase - Examples of all Shadcn UI components
• 🤖 Augment Ready - Optimized for AI coding assistance
• 🔧 TypeScript - Type safety and better developer experience
• 🎭 Tailwind CSS - Utility-first CSS framework

🚀 Getting Started

Prerequisites

• Node.js 18.17 or later
• npm, yarn, or pnpm

Installation

1. Clone the repository:

git clone https://github.com/AiCodingBattle/augment-nextjs-starterpack.git my-project
cd my-project

2. Install dependencies:

npm install --force
# or
yarn install --force
# or
pnpm install --force

3. Start the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

4. Open http://localhost:3000 in your browser to see the result.

📝 Important: Customize Your Augment Guidelines

⚠️ Before using Augment with this template, you must modify the .augment-guidelines file to fit your project's specific requirements.

The .augment-guidelines file contains instructions that help Augment understand your project structure, coding conventions, and preferences. By default, it includes some basic guidelines, but you should customize it to:

• Define your project's specific architecture
• Set coding standards and conventions
• Specify preferred patterns and approaches
• Include any project-specific context that would help Augment provide better assistance

To modify the guidelines:

1. Open the .augment-guidelines file in your project root
2. Update the sections with your project-specific information
3. Save the file

Augment will use these guidelines when helping you write code for your project.

🎨 Customization

Styling

This template uses Tailwind CSS for styling. You can customize the theme in the tailwind.config.js file.

Components

All Shadcn UI components are located in the src/components/ui directory. You can customize them to fit your needs.

To add a new Shadcn UI component:

npx shadcn-ui@latest add button

Pages

Create new pages in the src/app directory following the Next.js App Router conventions.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

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

🙏 Acknowledgements

• Next.js - The React Framework
• Shadcn UI - UI Components
• Tailwind CSS - Utility-first CSS framework
• Augment - AI coding assistant