mirror of
https://github.com/ajnart/homarr.git
synced 2025-11-13 17:05:47 +01:00
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
|
# Mantine Next Template
|
|||
|
|
|
|||
|
|
Get started with Mantine + Next with just a few button clicks.
|
|||
|
|
Click `Use this template` button at the header of repository or [follow this link](https://github.com/mantinedev/mantine-next-template/generate) and
|
|||
|
|
create new repository with `@mantine` packages. Note that you have to be logged in to GitHub to generate template.
|
|||
|
|
|
|||
|
|
## Features
|
|||
|
|
|
|||
|
|
This template comes with several essential features:
|
|||
|
|
|
|||
|
|
- Server side rendering setup for Mantine
|
|||
|
|
- Color scheme is stored in cookie to avoid color scheme mismatch after hydration
|
|||
|
|
- Storybook with color scheme toggle
|
|||
|
|
- Jest with react testing library
|
|||
|
|
- 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
|