Skip to content

Commit

Permalink
[docs] Improve example README files (#4580)
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Potoms <[email protected]>
Co-authored-by: Jan Potoms <[email protected]>
  • Loading branch information
bharatkashyap and Janpot authored Jan 9, 2025
1 parent 8ab17a3 commit 6b5e8d7
Show file tree
Hide file tree
Showing 10 changed files with 92 additions and 0 deletions.
2 changes: 2 additions & 0 deletions examples/core/auth-nextjs-email/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ To copy this example and customize it for your needs, run

```bash
npx create-toolpad-app@latest --example auth-nextjs-email
# or
pnpm dlx create-toolpad-app@latest --example auth-nextjs-email
```

and follow the instructions in the terminal.
Expand Down
2 changes: 2 additions & 0 deletions examples/core/auth-nextjs-pages-nextauth-4/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ To copy this example and customize it for your needs, run

```bash
npx create-toolpad-app@latest --example auth-nextjs-pages-nextauth-4
# or
pnpm dlx create-toolpad-app@latest --example auth-nextjs-pages-nextauth-4
```

and follow the instructions in the terminal.
Expand Down
2 changes: 2 additions & 0 deletions examples/core/auth-nextjs-pages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ To copy this example and customize it for your needs, run

```bash
npx create-toolpad-app@latest --example auth-nextjs-pages
# or
pnpm dlx create-toolpad-app@latest --example auth-nextjs-pages
```

and follow the instructions in the terminal.
Expand Down
2 changes: 2 additions & 0 deletions examples/core/auth-nextjs-passkey/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ To copy this example and customize it for your needs, run

```bash
npx create-toolpad-app@latest --example auth-nextjs-passkey
# or
pnpm dlx create-toolpad-app@latest --example auth-nextjs-passkey
```

and follow the instructions in the terminal.
Expand Down
2 changes: 2 additions & 0 deletions examples/core/auth-nextjs-themed/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ To copy this example and customize it for your needs, run

```bash
npx create-toolpad-app@latest --example auth-nextjs-themed
# or
pnpm dlx create-toolpad-app@latest --example auth-nextjs-themed
```

and follow the instructions in the terminal.
Expand Down
2 changes: 2 additions & 0 deletions examples/core/auth-nextjs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ GITHUB_CLIENT_SECRET=

```bash
npx auth secret
# or
pnpm dlx create-toolpad-app@latest --example auth-nextjs
```

### GitHub configuration
Expand Down
10 changes: 10 additions & 0 deletions examples/core/auth-vite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@

This template provides a minimal setup to get React working in Vite with HMR.

## Clone using `create-toolpad-app`

To copy this example and customize it for your needs, run

```bash
npx create-toolpad-app@latest --example auth-vite
# or
pnpm dlx create-toolpad-app@latest --example auth-vite
```

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
Expand Down
23 changes: 23 additions & 0 deletions examples/core/firebase-vite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,29 @@

This template provides a minimal setup to get React working in Vite with HMR, and authentication with Firebase.

## Setting up

The project requires a `.env` with the following variables:

```bash
VITE_FIREBASE_API_KEY=
VITE_FIREBASE_AUTH_DOMAIN=
VITE_FIREBASE_PROJECT_ID=
VITE_FIREBASE_STORAGE_BUCKET=
VITE_FIREBASE_MESSAGE_SENDER_ID=
VITE_FIREBASE_APP_ID=
```

## Clone using `create-toolpad-app`

To copy this example and customize it for your needs, run

```bash
npx create-toolpad-app@latest --example firebase-vite
# or
pnpm dlx create-toolpad-app@latest --example firebase-vite
```

Currently, two official plugins are available:

- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
Expand Down
35 changes: 35 additions & 0 deletions examples/core/tutorial/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Toolpad Core - Tutorial

This example provides a minimal setup to get Toolpad Core working with the Next.js App Router.

## Getting Started

First, run the development server:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

Open [http://localhost:5173](http://localhost:5173) with your browser to see the result.

## Clone using `create-toolpad-app`

To copy this example and customize it for your needs, run

```bash
npx create-toolpad-app@latest --example tutorial
# or
pnpm dlx create-toolpad-app@latest --example tutorial
```

and follow the instructions in the terminal.

## The source

[Check out the source code](https://github.com/mui/toolpad/tree/master/examples/core/tutorial/)
12 changes: 12 additions & 0 deletions examples/core/vite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@ bun dev

Open [http://localhost:5173](http://localhost:5173) with your browser to see the result.

## Clone using `create-toolpad-app`

To copy this example and customize it for your needs, run

```bash
npx create-toolpad-app@latest --example vite
# or
pnpm dlx create-toolpad-app@latest --example vite
```

and follow the instructions in the terminal.

## The source

[Check out the source code](https://github.com/mui/toolpad/tree/master/examples/core/vite/)

0 comments on commit 6b5e8d7

Please sign in to comment.