update
This commit is contained in:
41
README.md
41
README.md
@@ -1,39 +1,8 @@
|
||||
# Mantine Next Template
|
||||
# Mantine + Vite 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.
|
||||
Official [Mantine](https://mantine.dev/) + [Vite](https://vitejs.dev/) template.
|
||||
|
||||
## Features
|
||||
Links:
|
||||
|
||||
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
|
||||
- [Mantine documentation](https://mantine.dev/)
|
||||
- [Vite documentation](https://vitejs.dev/)
|
||||
|
||||
Reference in New Issue
Block a user