Tomilola-ng/nextjs15-starter

README

NextJs15 Starter

Starter Template For Next.js Applications

The NextJs15-starter is a highly optimized and feature-rich boilerplate for building modern web applications. It comes pre-configured with essential tools, libraries, and best practices, allowing you to focus on your application logic rather than setup.

Features

Next.js 15: Leverage the latest features of Next.js for high-performance SSR and static site generation.
Tailwind CSS 3.4: Beautiful and efficient utility-first CSS framework.
React 19: Harness the power of the latest React version.
Lucide React Icons: A collection of customizable icons for your UI needs.
Shadcn UI Components: Pre-designed components for consistent and fast UI development.
Framer Motion: Animate your components with ease using Framer Motion.
API Setup: Pre-configured API routes for seamless backend integration.
Global Restyling: Unified styling approach for a cohesive design system.
Zod Validation: Built-in schema validation for safer and more robust data handling.
Zustand State Management: Lightweight and scalable state management.
User Management API & Hooks: Integrated user authentication and management solutions.
Global Type Modules: Simplified TypeScript type management.
Sitemap Generation: Automatically generate sitemaps for better SEO.
Loading and Error Handling Templates: Pre-built components for Not Found, Global Error, and other states.
Editable Logo Component: Quickly adapt branding to your application.
Utility Code: Handy helper functions and modules to speed up development.

Getting Started

Prerequisites

Ensure you have the following installed:

Node.js (v18 or higher recommended)
npm or yarn

Installation

Clone the repository:

   git clone https://github.com/Tomilola-ng/nextjs15-starter.git

Navigate to the project directory:
```
   cd nextjs15-starter
```
Install dependencies:
```
npm install
# or
yarn install
```

Running the Application

Start the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 in your browser to see the application in action.

Building for Production

Generate a production build:

npm run build
# or
yarn build

Run the production server:

npm start
# or
yarn start

Project Structure

NextJs15-starter/
├── api/                 # API routes and utilities
├── app/                 # Application pages and API routes
├── components/          # Reusable UI components
├── config/              # Site configuration
├── hooks/               # Custom hooks
├── lib/                 # Utility functions and helpers
├── provider/            # Global providers
├── public/              # Static assets
├── styles/              # Global styles
├── types/               # TypeScript type definitions
└── ...                  # Other configuration and boilerplate files

Contributing

Contributions are welcome! Feel free to fork the repository and submit pull requests. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License.

Author

Tomilola-ng

GitHub: Tomilola-ng
Twitter: @Tomilola_ng

Acknowledgments

Special thanks to the open-source community for providing the amazing libraries and tools integrated into this starter template.