![thubnail](https://private-user-images.githubusercontent.com/76774237/302757200-44b552ff-43aa-441f-b1d0-de9bdfc2a73f.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjM4MzUwNzcsIm5iZiI6MTcyMzgzNDc3NywicGF0aCI6Ii83Njc3NDIzNy8zMDI3NTcyMDAtNDRiNTUyZmYtNDNhYS00NDFmLWIxZDAtZGU5YmRmYzJhNzNmLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MTYlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODE2VDE4NTkzN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTRhNTdmYjViZDNmOGVmMTQ5ZDA4Y2M5NDZmNGRlOGM1OWRkNzRlYTkzYzY3MzlkMjc5MGU4ZmY1YzI5OGM1MGImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.32gZxeF_P5dNQ0_XWk5QLcQ7DzeSqpP1Wk-zwg5LlmY)
Features · Deployment · Getting started · Scripts overview · Contribution · Support
- 🚀 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
Easily deploy your Next.js app with Vercel by clicking the button below:
-
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
npm install
Create .env
file and set env variables from .env.example
file.
It is required if you want husky to work
npm run prepare
You can start the server using this command:
npm run dev
and open http://localhost:3000/ to see this app.
The following scripts are available in the package.json
:
dev
: Run development serverbuild
: Build the appstart
: Run production serverpreview
: Runbuild
andstart
commands togetherlint
: Lint the code using Eslintlint:fix
: Fix linting errorsformat:check
: Checks the code for proper formattingformat:write
: Fix formatting issuestypecheck
: Type-check TypeScript without emitting filestest
: Run unit teststest:watch
: Run unit tests in watch modee2e
: Run end-to-end testse2e:ui
: Run end-to-end tests with UIpostbuild
: Generate sitemapprepare
: Install Husky for managing Git hooks
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.
If you liked the project, I will appreciate if you leave a star. 🌟😊
Made by Michał Skolak