Skip to content

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tigbbit committed Oct 8, 2024
1 parent f2e9433 commit 9f31a2c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ If you prefer Tailwind css, check this: [Tailwind-CSS-Version](https://github.co
## Clone this repository for React 19.x with NextJs 15.x or React 18.x with NextJs 14.x

- Clone & install React19-Next15-MUI6-TS-Starter:
- `git clone -b react19-nextjs15 https://github.com/AlexStack/nextjs-materia-mui-typescript-hook-form-scaffold-boilerplate-starter.git react19-nextjs15-mui6-ts-starter && cd react19-nextjs15-mui6-ts-starter && yarn install && yarn dev -p 3005`
- `git clone -b react19-nextjs15 https://github.com/tigbbit/Next-MUI-TS-Jest-template.git react19-nextjs15-mui6-ts-starter && cd react19-nextjs15-mui6-ts-starter && yarn install && yarn dev -p 3005`
- Open <http://localhost:3005>
- Note: React 19 is not released yet, there are some warnings in the console, please ignore them.
- Clone & install React18-Next14-MUI5-TS-Starter:
- `git clone -b nextjs14 https://github.com/AlexStack/nextjs-materia-mui-typescript-hook-form-scaffold-boilerplate-starter.git react18-nextjs14-mui5-ts-starter && cd react18-nextjs14-mui5-ts-starter && yarn install && yarn dev -p 3005`
- `git clone -b nextjs14 https://github.com/tigbbit/Next-MUI-TS-Jest-template.git react18-nextjs14-mui5-ts-starter && cd react18-nextjs14-mui5-ts-starter && yarn install && yarn dev -p 3005`
- Open <http://localhost:3005>

## Features
Expand Down Expand Up @@ -64,12 +64,12 @@ This starter is original from theodorusclarence/ts-nextjs-tailwind-starter, than
1. Test locally: Using `create-next-app`

```bash
npx create-next-app -e https://github.com/AlexStack/nextjs-materia-mui-typescript-hook-form-scaffold-boilerplate-starter new-project-name
npx create-next-app -e https://github.com/tigbbit/Next-MUI-TS-Jest-template new-project-name
```

2. Test online: Deploy to Vercel by one click

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2FAlexStack%2Fnextjs-materia-mui-typescript-hook-form-scaffold-boilerplate-starter&showOptionalTeamCreation=false)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?s=https://github.com/tigbbit/Next-MUI-TS-Jest-template.git=false)

### 2. Install dependencies

Expand Down Expand Up @@ -111,7 +111,7 @@ TEMPLATE
- [HiHB](https://hihb.com/)
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). πŸ˜ƒ
Are you using this starter? Please add your page (and repo) to the end of the list via a [Pull Request](https://github.com/tigbbit/Next-MUI-TS-Jest-template/edit/main/README.md). πŸ˜ƒ
## Folder structure
Expand All @@ -121,8 +121,6 @@ Are you using this starter? Please add your page (and repo) to the end of the li
🚘🚘🚘 [**Click here to see an online demo of below code**](https://mui-nextjs-ts.vercel.app) 🚘🚘🚘
![app/page.tsx code example](https://raw.githubusercontent.com/AlexStack/nextjs-materia-mui-typescript-hook-form-scaffold-boilerplate-starter/main/public/images/app-page-tsx.png)
## License
- MIT
2 changes: 1 addition & 1 deletion next-sitemap.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ module.exports = {
// !STARTERCONF Change the siteUrl
/** Without additional '/' on the end, e.g. https://google.com */
siteUrl:
'https://github.com/AlexStack/nextjs-materia-mui-typescript-hook-form-scaffold-boilerplate-starter',
'https://github.com/tigbbit/Next-MUI-TS-Jest-template',
generateRobotsTxt: true,
robotsTxtOptions: {
policies: [{ userAgent: '*', allow: '/' }],
Expand Down

0 comments on commit 9f31a2c

Please sign in to comment.