/nextarter-chakra

Primary LanguageTypeScriptMIT LicenseMIT

Deploy with Vercel Deploy to Netlify Deploy on Railway

Open in StackBlitz

This is a Next.js project bootstrapped with create-next-app, added with Chakra UI and TypeScript setup.
Start developing right away!

🔋 ⚡ Battery Packed template

  • 🚀 Next.js 13 - React 18
  • ⛓️ TypeScript
  • Chakra-UI v2
  • ✔️ toolings for linting, formatting, and conventions configured
    • eslint, prettier, husky, lint-staged, commitlint, commitizen, and standard-version
    • pre-commit, pre-push, commit-msg, prepare-commit-msg hook configured
  • 📱 PWA-ready - next-pwa configured, enabled by default, just disable it through next.config.js
  • 🔎 SEO optimization configured - with next-sitemap.
    • you'll need to reconfigure or tinker with it to get it right according to your needs, but it's there if you need it.
  • 🎨 basic responsive layout configured - don't need it? just remove it 😃
  • 🤖 Automatic Dependency Update with Renovate
  • 🏎️ Turbo setup
  • 🧪 Playwright E2E Test

CodeFactor Quality Gate Status Maintainability Rating Bugs Code Smells Duplicated Lines (%)

Commitizen friendly

Pre-requisites

  1. Node.js or nvm installed.
  2. pnpm installed.

Getting Started

  1. You can either click Use this template button on this repository and clone the repo or directly from your terminal:
npx degit sozonome/nextarter-chakra <YOUR_APP_NAME>

  1. After cloning the project, run this command: pnpm or pnpm install

  2. Then, run the development server:

pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying src/lib/pages/index.tsx. The page auto-updates as you edit the file.

How to Run e2e Test (in local machine)

  1. Build production with pnpm build, then run the production build using pnpm start.
  2. Open another terminal (or new terminal tab, don't cancel / close the production server), then run the test with pnpm test:e2e.

References: