Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 2.75 KB

README.md

File metadata and controls

69 lines (50 loc) · 2.75 KB

banner

Next.js app starter ☕
An app starter for Nextjs that includes TypeScript, ChakraUI and all the tools you need to build amazing projects 🔥🤗.

Alt

Commitizen friendly

Features

  • ☕ Next.js 14 (App Router)
  • 🥑 React 18
  • 🍇 TypeScript
  • 🍌 ESLint — To find and fix problems in your code
  • 🍍 Prettier — Code Formatter for consistent style
  • 🥭 EditorConfig - Consistent coding styles across editors and IDEs
  • 🍓 Path Mapping — Import components using the @ prefix
  • 🥥 Testing - Unit test and coverage with Vitest
  • 🌽 Conventional commit messages

Getting Started

This is a Next.js project bootstrapped with create-next-app.

First, run the development server:

npm install
npm run dev

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

Scripts

  • npm run dev — Starts the application in development mode at http://localhost:3000.
  • npm run build — Creates an optimized production build of your application.
  • npm run start — Starts the application in production mode.
  • npm run lint — Runs ESLint for all files in the directory.
  • npm run lint:fix — Runs ESLint and fix for all files in the directory.
  • npm run format — Runs Prettier for all files in the directory.
  • npm run postbuild — Generate site sitemap.
  • npm run commit — Run commitizen CLI and choose your commit message.
  • npm run test - Run test suite
  • npm run test:coverage - Run test coverage

Say thanks!

License

This project is licensed under the MIT License - see the LICENSE.md file for more information.