Skip to content

Latest commit

 

History

History
78 lines (65 loc) · 1.86 KB

README.md

File metadata and controls

78 lines (65 loc) · 1.86 KB

🚀 Next.js Ultimate Starter Kit

A powerful and highly customizable Next.js starter to kickstart frontend projects with modern development practices, built-in state management, and enhanced DX tools.

✨ Key Features :

  • Next.js 15 with App Router
  • TypeScript for safer code and better developer experience
  • React Query for efficient data fetching and caching
  • Redux for robust state management
  • Tailored Developer Experience with ESLint, Prettier, Husky
  • Internationalization (i18n) support for multilingual sites
  • Comprehensive Testing Setup with Jest for unit tests and Storybook for UI component testing

🚀 Quick Start :

Clone the repository, install dependencies, and start the development server.

git clone https://github.com/aelabid/Next-StarterKit.git
cd Next-StarterKit
npm install
npm run dev

Open http://localhost:3000 to view it in the browser.

📂 Folder Structure :

├── app/
│   ├── (routes)/
│   └── layout.tsx
├── components/
│   ├── ui/
│   └── layout/
├── public/
├── styles/
├── hooks/
├── services/
├── lib/
├── config/
├── context/
├── tests/
│   ├── cypress/
│   └── unitTest/
├── store/
└── i18n/

🛠️ Technologies Used :

  • React Query for API requests
  • Redux for local state
  • Jest & Storybook for testing
  • Tailwind CSS for styling

🏁 Getting Started :

Running Tests

  • Run unit tests with Jest:
npm run test
  • Run end-to-end tests with Cypress:
npm run cypress:open

🤝 Contributing :

We welcome contributions! Please follow our contributing guidelines and adhere to the code of conduct.

📝 License :

Distributed under the MIT License. See LICENSE for more information.