Make sure you have Node.js >= 18 installed.
Please use yarn so the husky hooks can work properly:
yarn install
The development server can be started using this command:
yarn dev
The development server is then running on http://localhost:3000.
This repository is using conventional commits, which are mandatory to use when committing changes.
build
: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)ci
: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)docs
: Documentation only changesfeat
: A new featurefix
: A bug fixperf
: A code change that improves performancerefactor
: A code change that neither fixes a bug nor adds a featurestyle
: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)test
: Adding missing tests or correcting existing tests
- Next.js 14 with App Router
- React 18
- TypeScript
- Tailwind CSS 3 + clsx + tailwind-merge
- Jest — Unit testing
- Absolute Import and Path Alias — Import components using
@/
and~/
prefix - ESLint — Find and fix problems in the code, also will auto sort imports
- Prettier — Consistent formatting
- Husky & Lint Staged - Run scripts on staged files before they are committed
- Conventional Commit Lint
- Github Actions — Check code on GitHub
- Issue Autolink — Links issue on PR creation
- Site Map — Automatically generate sitemap.xml
- VS Code Snippets
See how-to-write-blogposts.md.
Based on ts-nextjs-tailwind-starter by theodorusclarence
Copyright (C) 2023 Unit 214 GmbH.