mirror of
https://github.com/mantinedev/next-app-template.git
synced 2025-11-09 20:12:02 +10:00
39 lines
1.5 KiB
Markdown
39 lines
1.5 KiB
Markdown
# Mantine Next.js template
|
||
|
||
This is a template for [Next.js](https://nextjs.org/) pages router + [Mantine](https://mantine.dev/).
|
||
If you want to use app router instead, see [next-app-template](https://github.com/mantinedev/next-app-template).
|
||
|
||
## Features
|
||
|
||
This template comes with the following features:
|
||
|
||
- [PostCSS](https://postcss.org/) with [mantine-postcss-preset](https://mantine.dev/styles/postcss-preset)
|
||
- [TypeScript](https://www.typescriptlang.org/)
|
||
- [Storybook](https://storybook.js.org/)
|
||
- [Jest](https://jestjs.io/) setup with [React Testing Library](https://testing-library.com/docs/react-testing-library/intro)
|
||
- ESLint setup with [eslint-config-mantine](https://github.com/mantinedev/eslint-config-mantine)
|
||
|
||
## npm scripts
|
||
|
||
### Build and dev scripts
|
||
|
||
- `dev` – start dev server
|
||
- `build` – bundle application for production
|
||
- `export` – exports static website to `out` folder
|
||
- `analyze` – analyzes application bundle with [@next/bundle-analyzer](https://www.npmjs.com/package/@next/bundle-analyzer)
|
||
|
||
### Testing scripts
|
||
|
||
- `typecheck` – checks TypeScript types
|
||
- `lint` – runs ESLint
|
||
- `prettier:check` – checks files with Prettier
|
||
- `jest` – runs jest tests
|
||
- `jest:watch` – starts jest watch
|
||
- `test` – runs `jest`, `prettier:check`, `lint` and `typecheck` scripts
|
||
|
||
### Other scripts
|
||
|
||
- `storybook` – starts storybook dev server
|
||
- `storybook:build` – build production storybook bundle to `storybook-static`
|
||
- `prettier:write` – formats all files with Prettier
|