/next-template

A Next.js 13 template with shadcn/ui, Storybook, Husky, CSpell and other stuff.

Primary LanguageTypeScript

Next.js Template

A Next.js 13 with app directory template pre-configured with shadcn/ui and Tailwind CSS.

Technologies Used

  • Next.js: The foundation of the project, providing server-side rendering, routing, and more.
  • shadcn/ui: A collection of re-usable components built using Radix UI and Tailwind CSS.
  • @tanstack/react-query: A powerful library for managing and caching server state in your application. It simplifies data fetching, caching, and state management.
  • ky: A lightweight and elegant HTTP client for the browser that works seamlessly with modern web technologies.
  • Lucide: A collection of high-quality icons that you can easily incorporate into your application's UI.
  • zod: A robust and efficient TypeScript-first schema validation library to ensure your data is correctly structured.
  • ESLint: A popular JavaScript and TypeScript linter that helps you maintain a consistent and error-free codebase. It includes several plugins to enhance code quality, accessibility (a11y), Tailwind CSS, @tanstack/react-query, and import-helpers.
  • Prettier: An opinionated code formatter that ensures code consistency and improves code readability.
  • Husky: A tool that hooks into your Git workflow to run checks and tasks (such as linting and formatting) before commits, ensuring code quality and consistency.
  • CSpell: A library for spell checking code.

How to Use

Use the template with create-next-app

To create a new project based on this template using create-next-app, run the following command:

pnpm create next-app -e https://github.com/fellipeutaka/next-template

Contributing

If you'd like to contribute to this template or report issues, please follow these guidelines:

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
  1. Make your changes, commit, and push to your fork.
  2. Create a pull request against the main branch of this repository.

Happy coding! 🚀