Stockmart Template for Next JS 14+, Tailwind CSS 3.3 and TypeScript

🚀 Stockmart Template for Next JS 14+ with App Router support, Tailwind CSS and TypeScript ⚡️ Made with developer experience first: Next.js, TypeScript, ESLint, Prettier, Husky, Lint-Staged, Commitlint, Netlify, PostCSS, Tailwind CSS

Features

• ⚡ Next.js with App Router support
• 🔥 Type checking TypeScript
• 💎 Integrate with Tailwind CSS
• ✅ Strict Mode for TypeScript and React 18
• 🌈 Light and Dark Mode
• ♻️ Type-safe environment variables with T3 Env
• ⌨️ Form with React Hook From
• 📏 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
• 🎁 Automatic changelog generation with Semantic Release
• 💡 Absolute Imports using @ prefix
• 🗂 VSCode configuration: Debug, Settings, Tasks and extension for PostCSS, ESLint, Prettier, TypeScript
• 🤖 SEO metadata, JSON-LD and Open Graph tags with Next SEO
• 🗺️ Sitemap.xml and robots.txt with next-sitemap
• ⚙️ Bundler Analyzer
• 🖱️ One click deployment with Vercel or Netlify (or manual deployment to any hosting services)

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

Getting started

Run the following command on your local environment:

pnpm install or yarn install

Then, you can run locally in development mode with live reload:

pnpm dev or yarn dev

Open http://localhost:3000 with your favorite browser to see your project.

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 and public/favicon-32x32.png: your website favicon, you can generate from https://favicon.io/favicon-converter/
• src/styles/global.css: your CSS file using Tailwind CSS
• src/utils/AppConfig.ts: configuration file
• next-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:

pnpm 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.

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';

Deploy to production

Generate a production build with:

$ pnpm build or yarn build

It generates an optimized production build of the boilerplate. For testing the generated build, you can run:

$ pnpm start or yarn 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.

Deploy to Netlify

Clone this repository on own GitHub account and deploy to Netlify in one click:

Deploy to Vercel

Deploy this Next JS Boilerplate on Vercel in one click:

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 Cmd + Shift + B on Mac.

Contributions

Feel free to open an issue if you have question or found a bug. Totally open to any suggestions and improvements.

---

Made with ♥ by Devspherelabs | Themealchemy