Skip to content

Commit 1b5cefd

Browse files
committed
feat: install mui
1 parent e15a0c7 commit 1b5cefd

36 files changed

+6186
-28136
lines changed

CHANGELOG.md

Lines changed: 1 addition & 431 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 19 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
1-
# Next.js + Tailwind CSS + TypeScript Starter and Boilerplate
1+
# NextJs 13.x + MUI 5.x + React Hook Form + TypeScript Starter and Boilerplate
22

33
<div align="center">
4-
<h2>🔋 ts-nextjs-tailwind-starter</h2>
5-
<p>Next.js + Tailwind CSS + TypeScript starter packed with useful development features.</p>
6-
<p>Made by <a href="https://theodorusclarence.com">Theodorus Clarence</a></p>
4+
<h2>2023/2024: 🔋 NextJs 13.x + MUI 5.x + TypeScript Starter</h2>
5+
<p>The scaffold for NextJs 13.x (App Router), React Hook Form, Material UI(MUI 5.x),Typescript and ESLint, and TypeScript with Absolute Import, Seo, Link component, pre-configured with Husky.</p>
76

8-
[![GitHub Repo stars](https://img.shields.io/github/stars/theodorusclarence/ts-nextjs-tailwind-starter)](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/stargazers)
9-
[![Depfu](https://badges.depfu.com/badges/fc6e730632ab9dacaf7df478a08684a7/overview.svg)](https://depfu.com/github/theodorusclarence/ts-nextjs-tailwind-starter?project_id=30160)
10-
[![Last Update](https://img.shields.io/badge/deps%20update-every%20sunday-blue.svg)](https://shields.io/)
7+
If you prefer Tailwind css, check this: [Tailwind-CSS-Version](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter)
118

129
</div>
1310

1411
## Features
1512

1613
This repository is 🔋 battery packed with:
1714

18-
- ⚡️ Next.js 13 with App Router
19-
- ⚛️ React 18
15+
- ⚡️ Next.js 13.x with App Router
16+
- ⚛️ React 18.x
2017
- ✨ TypeScript
21-
- 💨 Tailwind CSS 3 — Configured with CSS Variables to extend the **primary** color
22-
- 💎 Pre-built Components — Components that will **automatically adapt** with your brand color, [check here for the demo](https://tsnext-tw.thcl.dev/components)
18+
- 💨 Material UI — Ready to use Material Design components [check here for the usage](https://mui.com/material-ui/getting-started/usage/)
19+
- 🎨 React Hook Form — Performant, flexible and extensible forms with easy-to-use validation
20+
- ⏰ Day.js — A modern day JavaScript Date Library
2321
- 🃏 Jest — Configured for unit testing
2422
- 📈 Absolute Import and Path Alias — Import components using `@/` prefix
2523
- 📏 ESLint — Find and fix problems in your code, also will **auto sort** your imports
@@ -34,45 +32,23 @@ This repository is 🔋 battery packed with:
3432
- 🗺 Site Map — Automatically generate sitemap.xml
3533
- 📦 Expansion Pack — Easily install common libraries, additional components, and configs.
3634

37-
See the 👉 [feature details and changelog](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/blob/main/CHANGELOG.md) 👈 for more.
35+
## Tailwind CSS Version
3836

39-
You can also check all of the **details and demos** on my blog post:
40-
41-
- [One-stop Starter to Maximize Efficiency on Next.js & Tailwind CSS Projects](https://theodorusclarence.com/blog/one-stop-starter)
37+
This starter is original from theodorusclarence/ts-nextjs-tailwind-starter, thank you theodorusclarence! If you prefer Tailwind css, check this: [Tailwind-CSS-Version](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter)
4238

4339
## Getting Started
4440

45-
### 1. Clone this template using one of the three ways:
46-
47-
1. Use this repository as template
48-
49-
**Disclosure:** by using this repository as a template, there will be an attribution on your repository.
50-
51-
I'll appreciate if you do, so this template can be known by others too 😄
52-
53-
![Use as template](https://user-images.githubusercontent.com/55318172/129183039-1a61e68d-dd90-4548-9489-7b3ccbb35810.png)
54-
55-
2. Using `create-next-app`
56-
57-
```bash
58-
npx create-next-app -e https://github.com/theodorusclarence/ts-nextjs-tailwind-starter project-name
59-
```
60-
61-
If you still want to use **pages directory** (_is not actively maintained_) you can use this command
41+
### 1. Clone this template using one of a few ways
6242

63-
```bash
64-
npx create-next-app -e https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/tree/pages-directory project-name
65-
```
66-
67-
3. Using `degit`
43+
1. Test locally: Using `create-next-app`
6844

6945
```bash
70-
npx degit theodorusclarence/ts-nextjs-tailwind-starter YOUR_APP_NAME
46+
npx create-next-app -e https://github.com/AlexStack/nextjs-materia-mui-typescript-hook-form-scaffold-boilerplate-starter new-project-name
7147
```
7248

73-
4. Deploy to Vercel
49+
2. Test online: Deploy to Vercel by one click
7450

75-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Ftheodorusclarence%2Fts-nextjs-tailwind-starter)
51+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/AlexStack/nextjs-materia-mui-typescript-hook-form-scaffold-boilerplate-starter)
7652

7753
### 2. Install dependencies
7854

@@ -104,29 +80,14 @@ Don't forget to change the package name in package.json
10480

10581
This starter is using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), it is mandatory to use it to commit changes.
10682

107-
## Projects using ts-nextjs-tailwind-starter
83+
## Projects using this starter
10884

10985
<!--
11086
TEMPLATE
11187
- [sitename](https://sitelink.com) ([Source](https://github.com/githublink))
11288
- [sitename](https://sitelink.com)
11389
-->
11490

115-
- [theodorusclarence.com](https://theodorusclarence.com) ([Source](https://github.com/theodorusclarence/theodorusclarence.com))
116-
- [Notiolink](https://notiolink.thcl.dev/) ([Source](https://github.com/theodorusclarence/notiolink))
117-
118-
Are you using this starter? Please add your page (and repo) to the end of the list via a [Pull Request](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/edit/main/README.md). 😃
119-
120-
## Expansion Pack 📦
121-
122-
This starter is now equipped with an [expansion pack](https://github.com/theodorusclarence/expansion-pack).
123-
124-
You can easily add expansion such as React Hook Form + Components, Storybook, and more just using a single command line.
125-
126-
https://user-images.githubusercontent.com/55318172/146631994-e1cac137-1664-4cfe-950b-a96decc1eaa6.mp4
127-
128-
Check out the [expansion pack repository](https://github.com/theodorusclarence/expansion-pack) for the commands
129-
130-
### App Router Update
91+
- [HiHB](https://hihb.com/)
13192

132-
Due to App Router update, the expansion pack is currently **outdated**. It will be updated in the future. You can still use them by copy and pasting the files.
93+
Are you using this starter? Please add your page (and repo) to the end of the list via a [Pull Request](https://github.com/AlexStack/nextjs-materia-mui-typescript-hook-form-scaffold-boilerplate-starter/edit/main/README.md). 😃

next-sitemap.config.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
*/
55
module.exports = {
66
// !STARTERCONF Change the siteUrl
7-
/** Without additional '/' on the end, e.g. https://theodorusclarence.com */
8-
siteUrl: 'https://tsnext-tw.thcl.dev',
7+
/** Without additional '/' on the end, e.g. https://google.com */
8+
siteUrl:
9+
'https://github.com/AlexStack/nextjs-materia-mui-typescript-hook-form-scaffold-boilerplate-starter',
910
generateRobotsTxt: true,
1011
robotsTxtOptions: {
1112
policies: [{ userAgent: '*', allow: '/' }],

0 commit comments

Comments
 (0)