next-js-eva-core v3.22.0
Features
Developer experience first:
- β‘ Next.js with App Router and Page Router support
- π₯ Type checking TypeScript
- π Integrate with Tailwind CSS
- β Strict Mode for TypeScript and React 18
- π Authentication with Clerk: Sign up, Sign in, Sign out, Forgot password, Reset password, and more.
- π½ Global Database with Turso
- β»οΈ Type-safe environment variables with T3 Env
- β¨οΈ Form with React Hook From
- π΄ Validation library with Zod
- π Linter with ESLint (default NextJS, NextJS Core Web Vitals, Tailwind CSS and Airbnb configuration)
- π Code Formatter with Prettier
- π¦ Husky for Git Hooks
- π« Lint-staged for running linters on Git staged files
- π Lint git commit with Commitlint
- π Write standard compliant commit messages with Commitizen
- π¦Ί Unit Testing with Jest and React Testing Library
- π· Run tests on pull request with GitHub Actions
- π Storybook for UI development
- π Automatic changelog generation with Semantic Release
- π Visual testing with Percy (Optional)
- π‘ Absolute Imports using
@
prefix - π VSCode configuration: Debug, Settings, Tasks and extension for PostCSS, ESLint, Prettier, TypeScript, Jest
- π€ SEO metadata, JSON-LD and Open Graph tags with Next SEO
- πΊοΈ Sitemap.xml and robots.txt with next-sitemap
- β Database exploration with Drizzle Studio and CLI migration tool with Drizzle Kit
- βοΈ Bundler Analyzer
- π±οΈ One click deployment with Vercel or Netlify (or manual deployment to any hosting services)
- π Include a FREE minimalist theme
- π― Maximize lighthouse score
Built-in feature from Next.js:
- β Minify HTML & CSS
- π¨ Live reload
- β Cache busting
Philosophy
- Nothing is hidden from you, so you have the freedom to make the necessary adjustments to fit your needs and preferences.
- Easy to customize
- Minimal code
- SEO-friendly
- π Production-ready
Requirements
- Node.js 16+ and npm
Set up authentication
Create a Clerk account at Clerk.com and create a new application in Clerk Dashboard. Then, copy NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY
and CLERK_SECRET_KEY
into .env.local
file (not tracked by Git):
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_pub_key
CLERK_SECRET_KEY=your_clerk_secret_key
Now, you can a fully working authentication system with Next.js: Sign up, Sign in, Sign out, Forgot password, Reset password, Update profile, Update password, Update email, Delete account, and more.
Project structure
.
βββ README.md # README file
βββ __mocks__ # Mocks for testing
βββ .github # GitHub folder
βββ .husky # Husky configuration
βββ .storybook # Storybook folder
βββ .vscode # VSCode configuration
βββ migrations # Database migrations
βββ public # Public assets folder
βββ scripts # Scripts folder
βββ src
β βββ app # Next JS App (App Router)
β βββ components # React components
β βββ layouts # Layouts components
β βββ libs # 3rd party libraries
β βββ models # Database models
β βββ styles # Styles folder
β βββ templates # Templates folder
β βββ utils # Utilities folder
β βββ validations # Validation schemas
βββ tailwind.config.js # Tailwind CSS configuration
βββ tsconfig.json # TypeScript configuration
Customization
You can easily configure Next js Boilerplate by making a search in the whole project with FIXME:
for making quick customization. Here is some of the most important files to customize:
public/apple-touch-icon.png
,public/favicon.ico
,public/favicon-16x16.png
andpublic/favicon-32x32.png
: your website favicon, you can generate from https://favicon.io/favicon-converter/src/styles/global.css
: your CSS file using Tailwind CSSsrc/utils/AppConfig.ts
: configuration filesrc/templates/Main.tsx
: default themenext-sitemap.config.js
: sitemap configuration.env
: default environment variables
You have access to the whole code source if you need further customization. The provided code is only example for you to start your project. The sky is the limit π.
Commit Message Format
The project enforces Conventional Commits specification. This means that all your commit messages must be formatted according to the specification. To help you write commit messages, the project uses Commitizen, an interactive CLI that guides you through the commit process. To use it, run the following command:
npm run commit
One of the benefits of using Conventional Commits is that it allows us to automatically generate a CHANGELOG
file. It also allows us to automatically determine the next version number based on the types of commits that are included in a release.
Testing
All tests are colocated with the source code inside the same directory. So, it makes it easier to find them. Unfortunately, it is not possible with the pages
folder which is used by Next.js for routing. So, what is why we have a pages.test
folder to write tests from files located in pages
folder.
Enable Edge runtime (optional)
The App Router folder is compatible with the Edge runtime. You can enable it by uncommenting the following lines src/app/layouts.tsx
:
// export const runtime = 'edge';
For your information, the database migration is not compatible with the Edge runtime. So, you need to disable the automatic migration in src/libs/DB.ts
:
if (process.env.NODE_ENV !== 'production') {
await migrate(db, { migrationsFolder: './migrations' });
}
After disabling it, you are required to run the migration manually with:
npm run db:migrate
You also require to run the command each time you want to update the database schema.
Deploy to production
During the build process, the database migration is automatically executed. So, you don't need to run the migration manually. But, in your environment variable, DATABASE_URL
and DATABASE_AUTH_TOKEN
need to be defined.
Then, you can generate a production build with:
$ npm run build
It generates an optimized production build of the boilerplate. For testing the generated build, you can run:
$ npm run start
The command starts a local server with the production build. Then, you can now open http://localhost:3000 with your favorite browser to see the project.
VSCode information (optional)
If you are VSCode users, you can have a better integration with VSCode by installing the suggested extension in .vscode/extension.json
. The starter code comes up with Settings for a seamless integration with VSCode. The Debug configuration is also provided for frontend and backend debugging experience.
With the plugins installed on your VSCode, ESLint and Prettier can automatically fix the code and show you the errors. Same goes for testing, you can install VSCode Jest extension to automatically run your tests and it also show the code coverage in context.
Pro tips: if you need a project wide type checking with TypeScript, you can run a build with <kbd>
Cmd</kbd>
+ <kbd>
Shift</kbd>
+ <kbd>
B</kbd>
on Mac.
7 months ago