https://github.com/binodnepali/next-with-material-ui-example-template
Next.js with material ui example template using typescript.
https://github.com/binodnepali/next-with-material-ui-example-template
material-ui mui nextjs nextjs-boilerplate nextjs-example nextjs-mui nextjs-starter nextjs-template nextjs-typescript nextjs-typescript-boilerplate nextjs-typescript-template
Last synced: 15 days ago
JSON representation
Next.js with material ui example template using typescript.
- Host: GitHub
- URL: https://github.com/binodnepali/next-with-material-ui-example-template
- Owner: binodnepali
- Created: 2020-05-17T17:50:51.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-02-12T09:37:22.000Z (over 1 year ago)
- Last Synced: 2025-05-19T02:07:19.456Z (about 1 month ago)
- Topics: material-ui, mui, nextjs, nextjs-boilerplate, nextjs-example, nextjs-mui, nextjs-starter, nextjs-template, nextjs-typescript, nextjs-typescript-boilerplate, nextjs-typescript-template
- Language: TypeScript
- Homepage:
- Size: 77.2 MB
- Stars: 25
- Watchers: 0
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Next.js With Material UI Example Template
This example template was scaffolded using [nextjs-with-typescript-example-template](https://github.com/binodnepali/nextjs-with-typescript-example-template).
## Before getting started
Make sure you have installed [Node.js 12.22.0 or higher](https://nodejs.org/en/) on your machine. You can use [nvm](https://github.com/nvm-sh/nvm) to manage multiple node version on your machine.
## Getting started
You can setup this project using npm or yarn package managers.
> I would recommend to installed or enabled [yarn](https://yarnpkg.com/getting-started) 1.22.15 or higher on your machine.
### Clone repo
```bash
git clone https://github.com/binodnepali/nextjs-with-material-ui-example-template.git
#or
git clone [email protected]:binodnepali/nextjs-with-material-ui-example-template.git
```
### Navigate to cloned repo
```bash
cd nextjs-with-material-ui-example-template
```
### Install dependencies
```bash
yarn install
#or
npm install
```
### Start development server
```bash
yarn dev
#or
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
### Build for production
```bash
yarn build
#or
npm run build
```
### Start preview server after build
```bash
yarn start
#or
npm run start
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
### Run release
Follow the [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/) in your repository. And when you're ready to release, run below scripts.
```bash
yarn release
#or
npm run release
```
## Learn More
To learn more about Next.js, ESLint, Prettier, StyleLint and lint-staged, take a look at the following resources:
* [Next.js Documentation](https://nextjs.org/docs) - Learn about Next.js features and API
* [Next.js ESLint](https://nextjs.org/docs/basic-features/eslint) - Learn about how to Next.js ESLint setup
* [Prettier Setup](https://prettier.io/docs/en/install.html) - Learn about how to setup prettier
* [Prettier Integrations](https://prettier.io/docs/en/related-projects.html) - Learn about how to setup prettier with other tools
* [ESLint Setup](https://eslint.org/docs/user-guide/getting-started) - Learn about how to ESLint
* [StyleLint Setup](https://stylelint.io/user-guide/get-started) - Learn about how to setup StyleLint
* [Lint Staged Setup](https://github.com/okonet/lint-staged) - Learn about how to setup lint-staged
* [Standard Version](https://github.com/conventional-changelog/standard-version) - Learn about how to setup standar version