forked from mantinedev/ui.mantine.dev
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
8 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,13 @@ | ||
| # Mantine Next.js template | ||
| # Mantine UI | ||
|
|
||
| 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). | ||
| [Mantine UI](https://ui.mantine.dev/) is a set of more than 120 responsive components built with [Mantine](https://mantine.dev/). All components support dark/light color scheme and Mantine theme customizations. Mantine UI is free for everyone. | ||
|
|
||
| ## Features | ||
| ## Contributing | ||
|
|
||
| This template comes with the following features: | ||
| Mantine UI is an open source project with MIT license – you can browse source code and use components | ||
| in your applications without any limitations. Although the project is open source, **we do not accept | ||
| any contributions to the codebase of Mantine UI (unless maintainers asked you to send a PR).** You can contribute to the [Mantine library](https://github.com/mantinedev/mantine) codebase instead. | ||
|
|
||
| - [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) | ||
| ## License | ||
|
|
||
| ## 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 | ||
| MIT |