Skip to content

README.md

Latest commit

 

History

History
129 lines (89 loc) · 3.56 KB

README.md

File metadata and controls

129 lines (89 loc) · 3.56 KB

🚀 NextJS Quickstart 👑 (v6)

Consider giving this a ⭐ to show your support! <3

Welcome to the Next.js Quickstart template for Kars Apps! This template supercharges your Next.js projects with all the essentials to get you started right away. Here’s what you’ll find inside:

  • 🎨 Fonts – 5 variable fonts & 2 Google fonts pre-installed
  • 🔄 Smooth Scroll – Scroll hijacking with Lenis
  • 🎉 Animations – Animated with AOS and GSAP
  • ✨ Next.js Conventions – Following best practices and conventions
  • 🌈 Tailwind CSS – Tailwind support right out of the box
  • 🔐 Proxy – Pre-configured for speedy authentication
  • 📂 Routes – Custom 404 and API routes ready to go
  • 🛡️ Rate Limiting - Built-in Redis/Memory rate limiting for API protection
  • ⚙️ Config - Site-wide configuration system for easy customization
  • 🔗 Prisma – Set up for seamless database integration
  • 🧩 UI Library – Integrates ShadCN
  • 🚀 Transitions – Clean page loading transitions
  • 🌐 API - Custom Axios wrapper for easy API requests
  • 🎯 Form Validation - Built-in validation system with comprehensive error handling
  • 🗂️ Modular Architecture - Reorganized codebase with better separation of concerns
  • 📊 API Demos - Example endpoint showcasing validation patterns

Created with ❤️ by Create-Kapp!

🆕 Latest Update

Next 16: This project now supports nextjs 16!

🚀 Getting Started

  1. Install Dependencies: Let’s get those packages installed! Run one of the following:

    npm i
# or
yarn
# or
pnpm i

  2. Run the Development Server: Start up the server with:

    npm run dev
# or
yarn dev
# or
pnpm dev

    Open http://localhost:3000 to see your app in action!

⚡ Quickstart Using create-kapp

Get started with create-kapp for an instant setup:

npm i create-kapp@latest -g

Then initialize this template with the command:

create-kapp

You’ll see a prompt like this:

o   --------------------------------------------+
|                                               |
|   Welcome to KAPP. Let's make your project!   |
|                                               |
o   --------------------------------------------+
|
?   Which Template Category would you like to use? » - Use arrow-keys. Return to submit.
>   Next.js
    Discord.js
    General

Just follow the prompts to set up your project in no time! 🚀

💻 Cloning This Repository

Choose one of the following options to clone the template:

Option 1: Existing Folder

If you’re cloning into an already existing folder, run:

gh repo clone kars1996/Template .

Option 2: New Folder

To clone into a new folder, use:

gh repo clone kars1996/Template <folder-name>

Once cloned, open http://localhost:3000 to view your app.

🛠️ Start Customizing!

Edit app/page.tsx to get started. The page auto-updates as you edit, so you can see changes instantly.

Thanks for checking out this quickstart template! Feel free to reach out with suggestions or improvements. Happy coding! 🎉