Hi,
I created a starter template for next.js, it also contains typescript, tailwind, shadcn/ui. I have already written about it here, but I have added some new functionalities such as: Next-auth, Prisma, React-hook-form, T3-env.
I want to create a CLI for this project in the near future. What technologies that are not included in the project could be added?
If you liked the project, I will appreciate if you leave a star. 🌟
https://github.com/Skolaczk/next-starter
Overview
A Next.js starter template, packed with features like TypeScript, Tailwind CSS, Next-auth, Eslint, testing tools and more. Jumpstart your project with efficiency and style.
🎉 Features
- 🚀 Next.js 14 (App router)
- ⚛️ React 18
- 📘 Typescript
- 🎨 TailwindCSS - Class sorting, merging and linting
- 🛠️ Shadcn/ui - Customizable UI components
- 🔒 Next-auth - Easy authentication library for Next.js (GitHub provider)
- 🛡️ Prisma - ORM for node.js
- 📋 React-hook-form - Manage your forms easy and efficient
- 🔍 Zod - Schema validation library
- 🧪 Jest & React Testing Library - Configured for unit testing
- 🎭 Playwright - Configured for e2e testing
- 📈 Absolute Import & Path Alias - Import components using
@/prefix - 💅 Prettier - Code formatter
- 🧹 Eslint - Code linting tool
- 🐶 Husky & Lint Staged - Run scripts on your staged files before they are committed
- 🔹 Icons - From Lucide
- 🌑 Dark mode - With next-themes
- 🗺️ Sitemap & robots.txt - With next-sitemap
- 📝 Commitlint - Lint your git commits
- 🤖 Github actions - Lint your code on PR
- ⚙️ T3-env - Manage your environment variables
- 💯 Perfect Lighthouse score
🚀 Deployment
Easily deploy your Next.js app with Vercel by clicking the button below:
🎯 Getting started
1. Clone this template in one of three ways
- Using this repository as template
- Using
create-next-app
npx create-next-app -e https://github.com/Skolaczk/next-starter my-project-name
- Using
git clone
git clone https://github.com/Skolaczk/next-starter my-project-name
2. Install dependencies
npm install
3. Set up environment variables
Create .env file and set env variables from .env.example file.
4. Prepare husky
It is required if you want husky to work
npm run prepare
5. Run the dev server
You can start the server using this command:
npm run dev
and open http://localhost:3000/ to see this app.
⚙️ Scripts overview
The following scripts are available in the package.json:
-
dev: Run development server -
build: Build the app -
start: Run production server -
preview: Runbuildandstartcommands together -
lint: Lint the code using Eslint -
lint:fix: Fix linting errors -
format:check: Checks the code for proper formatting -
format:write: Fix formatting issues -
typecheck: Type-check TypeScript without emitting files -
test: Run unit tests -
test:watch: Run unit tests in watch mode -
e2e: Run end-to-end tests -
e2e:ui: Run end-to-end tests with UI -
postbuild: Generate sitemap -
prepare: Install Husky for managing Git hooks
🤝 Contribution
To contribute, please follow these steps:
- Fork the repository.
- Create a new branch.
- Make your changes, and commit them.
- Push your changes to the forked repository.
- Create a pull request.
❤️ Support
If you liked the project, I will appreciate if you leave a star. 🌟😊
Made by Michał Skolak
Top comments (3)
What a comprehensive and feature-packed Next.js starter template you've created! 🚀 The inclusion of TypeScript, Tailwind CSS, Shadcn/ui, Next-auth, Prisma, React-hook-form, and T3-env makes it an all-in-one solution for getting a project up and running efficiently.
The planned addition of a CLI in the future sounds like a great enhancement. As for additional technologies to consider, you might explore incorporating GraphQL for efficient data fetching, or perhaps integrating a state management library like Redux for larger applications.
Overall, this is a fantastic resource for developers looking to kickstart a Next.js project with a solid foundation.
Thanks ❤️
sounds good, will give it a shot