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

[website][docs][cli] Make Core the default project #3868

Merged
merged 12 commits into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from 8 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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ Toolpad Studio is in its beta stages of development. Feel free to run this appli
Run:

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

## Documentation
Expand Down
13 changes: 12 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,22 @@

1. Smoke test the release with the [CodeSandbox CI](https://ci.codesandbox.io/status/mui/mui-toolpad) package of the PR branch:

1. Run
a. Run Toolpad Core

```bash
npx https://pkg.csb.dev/mui/mui-toolpad/commit/<build>/create-toolpad-app smoke --use-pnpm
cd smoke
pnpm add https://pkg.csb.dev/mui/mui-toolpad/commit/<build>/@toolpad/core -S
pnpm dedupe && pnpm dev
```

And verify the app runs

b. Run Toolpad Studio

```bash
npx https://pkg.csb.dev/mui/mui-toolpad/commit/<build>/create-toolpad-app --studio smoke --use-pnpm
cd smoke
pnpm add https://pkg.csb.dev/mui/mui-toolpad/commit/<build>/@toolpad/studio -S
pnpm dedupe && pnpm dev
```
Expand Down
6 changes: 3 additions & 3 deletions docs/data/toolpad/core/introduction/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ title: Toolpad Core - Installation
<codeblock storageKey="package-manager">

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

```bash pnpm
pnpm create toolpad-app --core
pnpm create toolpad-app
```

```bash yarn
yarn create toolpad-app --core
yarn create toolpad-app
```

</codeblock>
Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/studio/getting-started/first-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Make sure to [install Node.js](https://nodejs.org/en) on your system.
1. Create a new application

```bash
npx create-toolpad-app@latest dog-app
npx create-toolpad-app@latest --studio dog-app
```

1. Start the development server
Expand Down
6 changes: 3 additions & 3 deletions docs/data/toolpad/studio/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ Then run the command:
<codeblock storageKey="package-manager">

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

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

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

</codeblock>
Expand Down
32 changes: 0 additions & 32 deletions docs/pages/toolpad/core/index.js

This file was deleted.

54 changes: 10 additions & 44 deletions docs/pages/toolpad/index.js
Original file line number Diff line number Diff line change
@@ -1,64 +1,30 @@
import * as React from 'react';
import NoSsr from '@mui/material/NoSsr';
import Head from 'docs/src/modules/components/Head';
import CssBaseline from '@mui/material/CssBaseline';
import Divider from '@mui/material/Divider';
import BrandingCssVarsProvider from 'docs/src/BrandingCssVarsProvider';
import Divider from '@mui/material/Divider';
import CssBaseline from '@mui/material/CssBaseline';
import AppHeader from 'docs/src/layouts/AppHeader';
import AppFooter from 'docs/src/layouts/AppFooter';
import AppHeaderBanner from 'docs/src/components/banner/AppHeaderBanner';
import Examples from '../../src/components/landing/Examples';
import Hero from '../../src/components/landing/Hero';
import HeroVideo from '../../src/components/landing/HeroVideo';
import SignUpToast from '../../src/components/landing/SignUpToast';
import UseCases from '../../src/components/landing/UseCases';
import CardGrid from '../../src/components/landing/CardGrid';
import Pricing from '../../src/components/landing/PricingTable';
import Marquee from '../../src/components/landing/Marquee';
import features from '../../data/toolpad/studio/landing/features';
import useCases from '../../data/toolpad/studio/landing/useCases';
import marquee from '../../data/toolpad/studio/landing/marquee';
import {
Headline,
plans,
planInfo,
rowHeaders,
communityData,
commercialData,
} from '../../data/toolpad/studio/landing/pricing';
import Features from '../../src/components/landing/Features';
import BuiltWith from '../../src/components/landing/BuiltWith';
import StudioIntro from '../../src/components/landing/StudioIntro';

export default function Home() {
return (
<BrandingCssVarsProvider>
<Head
title="Toolpad: Low-code admin builder"
description="Build apps with Material UI components, connect to data sources, APIs and build your internal tools 10x faster. Open-source and powered by MUI."
card="/static/toolpad/marketing/toolpad-og.jpg"
/>
<NoSsr>
<SignUpToast />
</NoSsr>
<CssBaseline />
<AppHeaderBanner />
<AppHeader gitHubRepository="https://github.com/mui/mui-toolpad" />
<main id="main-content">
<Hero />
<HeroVideo />
<Divider />
<UseCases content={useCases} />
<Divider />
<CardGrid content={features} />
<Divider />
<Pricing
Headline={Headline}
plans={plans}
planInfo={planInfo}
rowHeaders={rowHeaders}
commercialData={commercialData}
communityData={communityData}
/>
<Features />
<Divider />
<Marquee content={marquee} />
<BuiltWith />
<Divider />
<Examples />
<StudioIntro />
</main>
<AppFooter />
</BrandingCssVarsProvider>
Expand Down
66 changes: 66 additions & 0 deletions docs/pages/toolpad/studio/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import * as React from 'react';
import NoSsr from '@mui/material/NoSsr';
import Head from 'docs/src/modules/components/Head';
import CssBaseline from '@mui/material/CssBaseline';
import Divider from '@mui/material/Divider';
import BrandingCssVarsProvider from 'docs/src/BrandingCssVarsProvider';
import AppHeader from 'docs/src/layouts/AppHeader';
import AppFooter from 'docs/src/layouts/AppFooter';
import AppHeaderBanner from 'docs/src/components/banner/AppHeaderBanner';
import Hero from '../../../src/components/landing-studio/Hero';
import HeroVideo from '../../../src/components/landing-studio/HeroVideo';
import SignUpToast from '../../../src/components/landing-studio/SignUpToast';
import UseCases from '../../../src/components/landing-studio/UseCases';
import CardGrid from '../../../src/components/landing-studio/CardGrid';
import Pricing from '../../../src/components/landing-studio/PricingTable';
import Marquee from '../../../src/components/landing-studio/Marquee';
import features from '../../../data/toolpad/studio/landing/features';
import useCases from '../../../data/toolpad/studio/landing/useCases';
import marquee from '../../../data/toolpad/studio/landing/marquee';
import {
Headline,
plans,
planInfo,
rowHeaders,
communityData,
commercialData,
} from '../../../data/toolpad/studio/landing/pricing';

export default function Home() {
return (
<BrandingCssVarsProvider>
<Head
title="Toolpad: Low-code admin builder"
description="Build apps with Material UI components, connect to data sources, APIs and build your internal tools 10x faster. Open-source and powered by MUI."
card="/static/toolpad/marketing/toolpad-og.jpg"
/>
<NoSsr>
<SignUpToast />
</NoSsr>
<CssBaseline />
<AppHeaderBanner />
<AppHeader gitHubRepository="https://github.com/mui/mui-toolpad" />
<main id="main-content">
<Hero />
<HeroVideo />
<Divider />
<UseCases content={useCases} />
<Divider />
<CardGrid content={features} />
<Divider />
<Pricing
Headline={Headline}
plans={plans}
planInfo={planInfo}
rowHeaders={rowHeaders}
commercialData={commercialData}
communityData={communityData}
/>
<Divider />
<Marquee content={marquee} />
<Divider />
</main>
<AppFooter />
</BrandingCssVarsProvider>
);
}
82 changes: 0 additions & 82 deletions docs/src/components/landing-core/Hero.js

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ import Button from '@mui/material/Button';
import KeyboardArrowRightRounded from '@mui/icons-material/KeyboardArrowRightRounded';
import { Link } from '@mui/docs/Link';
import NpmCopyButton from 'docs/src/components/action/NpmCopyButton';
import GithubStars from '../landing/GithubStars';

export default function GetStartedButtons(props) {
const { installation, primaryLabel, primaryUrl, ...other } = props;
const { installation, primaryLabel, primaryUrl, secondaryLabel, secondaryUrl, ...other } = props;
return (
<React.Fragment>
<Box
Expand All @@ -26,6 +25,7 @@ export default function GetStartedButtons(props) {
href={primaryUrl}
component={Link}
noLinkStyle
size="large"
variant="contained"
endIcon={<KeyboardArrowRightRounded />}
sx={{
Expand All @@ -36,7 +36,20 @@ export default function GetStartedButtons(props) {
>
{primaryLabel}
</Button>
<GithubStars />
{secondaryUrl ? (
<Button
href={secondaryUrl}
component={Link}
noLinkStyle
target={'_blank'}
variant="outlined"
size="large"
color="secondary"
endIcon={<KeyboardArrowRightRounded />}
>
{secondaryLabel}
</Button>
) : null}
</Box>
<NpmCopyButton installation={installation} sx={{ mt: 2 }} />
</React.Fragment>
Expand Down
Loading
Loading