Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Fix npx folder confusion #2346

Merged
merged 3 commits into from
Jul 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<div align="center">

Quickly build internal tools. MUI Toolpad is a self-hosted low-code internal tools builder designed to extend the [MUI](https://mui.com/) React components. It's designed for developers of all trade who want to save time building internal applications.
Quickly build internal tools. MUI Toolpad is a self-hosted low-code internal tools builder designed to extend the [MUI](https://mui.com/) React components. It's designed for developers of all trades who want to save time building internal applications.

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mui/material-ui/blob/HEAD/LICENSE)

Expand All @@ -27,15 +27,15 @@ Quickly build internal tools. MUI Toolpad is a self-hosted low-code internal too

## We are making some changes

A [big change](https://github.com/mui/mui-toolpad/discussions/1748) is coming: we're making Toolpad focus much more on integrating with your IDE, while providing the ease of building UI fast with a drag and drop.
A [big change](https://github.com/mui/mui-toolpad/discussions/1748) is coming: we're making Toolpad focus much more on integrating with your IDE while providing the ease of building UI fast with a drag and drop.

## Product walkthrough

https://github.com/mui/mui-toolpad/assets/92228082/03d3da62-a8a7-4d2d-a07e-975744af9683

## Notice

MUI Toolpad is in its beta stages of development. Feel free to run this application to try it out for your use-cases, and share any feedback, bug reports or feature requests that you come across.
MUI Toolpad is in its beta stages of development. Feel free to run this application to try it out for your use cases, and share any feedback, bug reports or feature requests that you come across.

## Quick setup locally

Expand All @@ -44,11 +44,11 @@ MUI Toolpad is in its beta stages of development. Feel free to run this applicat
Run:

```bash
npx create-toolpad-app my-app
npx create-toolpad-app@latest my-toolpad-app
# or
yarn create toolpad-app my-app
yarn create toolpad-app my-toolpad-app
# or
pnpm create toolpad-app my-app
pnpm create toolpad-app my-toolpad-app
```

## Documentation
Expand Down
37 changes: 31 additions & 6 deletions docs/data/toolpad/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,51 @@

## Create a Toolpad app

Start by opening a terminal and `cd` into a folder you'd like to create your applicarion in. Then run the command
Start by opening a terminal and `cd` into a folder you'd like to create your applicarion in.
Then run the command:

```bash
npx create-toolpad-app my-app
<codeblock storageKey="package-manager">

```bash npm
npx create-toolpad-app@latest my-toolpad-app
```

```bash yarn
yarn create toolpad-app my-toolpad-app
```

> This will run the `create-toolpad-app` CLI which initializes the directory `./my-app` with a Toolpad application.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is for quotes

```bash pnpm
pnpm create toolpad-app my-toolpad-app
```

</codeblock>

This will run the `create-toolpad-app` CLI which initializes the directory `./my-toolpad-app` with a Toolpad application.

## Run the Toolpad editor

Change the current working directory to the application folder:

```bash
cd my-app
cd my-toolpad-app
```

Then start the development mode

```bash
<codeblock storageKey="package-manager">

```bash npm
npm run dev
```

```bash yarn
yarn dev
```

```bash pnpm
pnpm run dev
```

</codeblock>

This starts the development server on port `3000` or the first available port after that and opens the browser to the Toolpad editor.
5 changes: 4 additions & 1 deletion docs/src/components/landing/Hero.js
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,10 @@ export default function Hero() {
Build scalable and secure internal tools locally. Drag and drop to build UI, then connect
to data sources with your own code.
</Typography>
<GetStartedButtons installation={'npx create-toolpad-app'} to={ROUTES.toolpadQuickstart} />
<GetStartedButtons
installation={'npx create-toolpad-app@latest'}
to={ROUTES.toolpadQuickstart}
/>
<Box
sx={{
mt: 2,
Expand Down
3 changes: 2 additions & 1 deletion packages/create-toolpad-app/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Create Toolpad App

The simplest method to start with Toolpad is by using `create-toolpad-app`. This CLI tool enables you to quickly start building a new Toolpad application, with everything already set up.
The simplest method to start with Toolpad is by using `create-toolpad-app`.
This CLI tool enables you to quickly start building a new Toolpad application, with everything already set up.

## Interactive

Expand Down