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.

Sign up for GitHub

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

Jump to bottom

refactor(console): add aggregated npm installation component #6159

Merged
merged 1 commit into from
Jul 2, 2024
Merged

refactor(console): add aggregated npm installation component #6159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions packages/console/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,7 @@
},
"alias": {
"@/*": "./src/$1",
"@cloud/*": "./src/cloud/$1",
"@mdx/components/*": "./src/mdx-components/$1"
"@cloud/*": "./src/cloud/$1"
},
"stylelint": {
"extends": "@silverhand/eslint-config-react/.stylelintrc"
Expand Down
4 changes: 2 additions & 2 deletions packages/console/src/assets/docs/guides/api-express/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import Tabs from '@/mdx-components/Tabs';
import TabItem from '@/mdx-components/TabItem';
import InlineNotification from '@/ds-components/InlineNotification';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
Expand Down
4 changes: 2 additions & 2 deletions packages/console/src/assets/docs/guides/api-spring-boot/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import Tabs from '@/mdx-components/Tabs';
import TabItem from '@/mdx-components/TabItem';
import InlineNotification from '@/ds-components/InlineNotification';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
Expand Down
4 changes: 2 additions & 2 deletions packages/console/src/assets/docs/guides/m2m-general/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import Tabs from '@/mdx-components/Tabs';
import TabItem from '@/mdx-components/TabItem';
import InlineNotification from '@/ds-components/InlineNotification';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
Expand Down
10 changes: 4 additions & 6 deletions packages/console/src/assets/docs/guides/native-capacitor/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import UriInputField from '@/mdx-components/UriInputField';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
import NpmLikeInstallation from '@/mdx-components/NpmLikeInstallation';

import capaticorIos from './assets/capacitor-ios.webp';
import logtoSignInPage from './assets/logto-sign-in-page.webp';
Expand All @@ -18,12 +19,9 @@ To get started, you need to create a Capacitor project. You can follow the [offi

This tutorial is framework-agnostic, so you can use any UI framework you prefer and update the code accordingly.

```bash
# or yarn, pnpm
npm install @logto/capacitor
# Install peer dependencies
npm install @capacitor/browser @capacitor/app @capacitor/preferences
```
First, install Logto Capacitor SDK and its peer dependencies:

<NpmLikeInstallation packageName="@logto/capacitor @capacitor/browser @capacitor/app @capacitor/preferences" />

</Step>

Expand Down
32 changes: 2 additions & 30 deletions packages/console/src/assets/docs/guides/native-expo/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import UriInputField from '@/mdx-components/UriInputField';
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import NpmLikeInstallation from '@/mdx-components/NpmLikeInstallation';
import InlineNotification from '@/ds-components/InlineNotification';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
Expand All @@ -14,34 +13,7 @@ import RedirectUrisNative, { defaultRedirectUri } from '../../fragments/_redirec
subtitle="Install Logto SDK and peer dependencies"
>

<Tabs>

<TabItem value="npm" label="npm">

```bash
npm i @logto/rn
npm i expo-crypto expo-secure-store expo-web-browser @react-native-async-storage/async-storage
```

</TabItem>
<TabItem value="yarn" label="Yarn">

```bash
yarn add @logto/rn
yarn add expo-crypto expo-secure-store expo-web-browser @react-native-async-storage/async-storage
```

</TabItem>
<TabItem value="pnpm" label="pnpm">

```bash
pnpm add @logto/rn
pnpm add expo-crypto expo-secure-store expo-web-browser @react-native-async-storage/async-storage
```

</TabItem>

</Tabs>
<NpmLikeInstallation packageName="@logto/rn expo-crypto expo-secure-store expo-web-browser @react-native-async-storage/async-storage" />

The `@logto/rn` package is the SDK for Logto. The remaining packages are its peer dependencies. They couldn't be listed as direct dependencies because the Expo CLI requires that all dependencies for native modules be installed directly within the root project's `package.json`.

Expand Down
4 changes: 2 additions & 2 deletions packages/console/src/assets/docs/guides/native-flutter/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import UriInputField from '@/mdx-components/UriInputField';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import Tabs from '@/mdx-components/Tabs';
import TabItem from '@/mdx-components/TabItem';
import InlineNotification from '@/ds-components/InlineNotification';
import Checkpoint from '../../fragments/_checkpoint.md';
import RedirectUrisNative, { defaultRedirectUri } from '../../fragments/_redirect-uris-native.mdx';
Expand Down
4 changes: 2 additions & 2 deletions packages/console/src/assets/docs/guides/native-ios-swift/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import UriInputField from '@/mdx-components/UriInputField';
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import Tabs from '@/mdx-components/Tabs';
import TabItem from '@/mdx-components/TabItem';
import InlineNotification from '@/ds-components/InlineNotification';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
Expand Down
25 changes: 2 additions & 23 deletions packages/console/src/assets/docs/guides/spa-angular/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import UriInputField from '@/mdx-components/UriInputField';
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import InlineNotification from '@/ds-components/InlineNotification';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
import NpmLikeInstallation from '@/mdx-components/NpmLikeInstallation';

import Checkpoint from '../../fragments/_checkpoint.md';
import RedirectUrisWeb, {defaultRedirectUri, defaultPostSignOutUri} from '../../fragments/_redirect-uris-web.mdx';
Expand All @@ -14,29 +13,9 @@ import RedirectUrisWeb, {defaultRedirectUri, defaultPostSignOutUri} from '../../
title="Installation"
subtitle="Install Logto JS core SDK and `angular-auth-oidc-client`"
>
<Tabs>
<TabItem value="npm" label="npm">

```bash
npm i @logto/js angular-auth-oidc-client
```

</TabItem>
<TabItem value="pnpm" label="pnpm">

```bash
pnpm add @logto/js angular-auth-oidc-client
```

</TabItem>
<TabItem value="yarn" label="yarn">

```bash
yarn add @logto/js angular-auth-oidc-client
```
<NpmLikeInstallation packageName="@logto/js angular-auth-oidc-client" />

</TabItem>
</Tabs>
</Step>

<Step title="Configure redirect URIs">
Expand Down
24 changes: 1 addition & 23 deletions packages/console/src/assets/docs/guides/spa-react/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
import UriInputField from '@/mdx-components/UriInputField';
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import InlineNotification from '@/ds-components/InlineNotification';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
Expand All @@ -14,29 +12,9 @@ import RedirectUrisWeb, { defaultRedirectUri, defaultPostSignOutUri } from '../.
title="Installation"
subtitle="Install Logto SDK for your project"
>
<Tabs>
<TabItem value="npm" label="npm">

```bash
npm i @logto/react
```

</TabItem>
<TabItem value="pnpm" label="pnpm">

```bash
pnpm add @logto/react
```

</TabItem>
<TabItem value="yarn" label="yarn">

```bash
yarn add @logto/react
```
<NpmLikeInstallation packageName="@logto/react" />

</TabItem>
</Tabs>
</Step>

<Step title="Init Logto provider">
Expand Down
5 changes: 2 additions & 3 deletions packages/console/src/assets/docs/guides/spa-vanilla/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import UriInputField from '@/mdx-components/UriInputField';
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import Tabs from '@/mdx-components/Tabs';
import TabItem from '@/mdx-components/TabItem';
import InlineNotification from '@/ds-components/InlineNotification';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
Expand Down Expand Up @@ -39,7 +39,6 @@ yarn add @logto/browser
<TabItem value="cdn" label="CDN">

```html
<!-- Special thanks to jsdelivr -->
<script type="module">
import LogtoClient from 'https://cdn.jsdelivr.net/npm/@logto/browser@latest/+esm';
</script>
Expand Down
26 changes: 2 additions & 24 deletions packages/console/src/assets/docs/guides/spa-vue/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import UriInputField from '@/mdx-components/UriInputField';
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import InlineNotification from '@/ds-components/InlineNotification';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
import NpmLikeInstallation from '@/mdx-components/NpmLikeInstallation';

import Checkpoint from '../../fragments/_checkpoint.md';
import RedirectUrisWeb from '../../fragments/_redirect-uris-web.mdx';
Expand All @@ -15,30 +14,9 @@ import { defaultRedirectUri, defaultPostSignOutUri } from '../../fragments/_redi
title="Installation"
subtitle="Install Logto SDK for your project"
>
<Tabs>
<TabItem value="npm" label="npm">

```bash
npm i @logto/vue
```

</TabItem>
<TabItem value="pnpm" label="pnpm">

```bash
pnpm add @logto/vue
```

</TabItem>
<TabItem value="yarn" label="yarn">

```bash
yarn add @logto/vue
```

</TabItem>
<NpmLikeInstallation packageName="@logto/vue" />

</Tabs>
</Step>

<Step
Expand Down
4 changes: 2 additions & 2 deletions packages/console/src/assets/docs/guides/spa-webflow/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import UriInputField from '@/mdx-components/UriInputField';
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import Tabs from '@/mdx-components/Tabs';
import TabItem from '@/mdx-components/TabItem';
import InlineNotification from '@/ds-components/InlineNotification';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
Expand Down
28 changes: 3 additions & 25 deletions packages/console/src/assets/docs/guides/web-express/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import UriInputField from '@/mdx-components/UriInputField';
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import InlineNotification from '@/ds-components/InlineNotification';
import { generateStandardSecret } from '@logto/shared/universal';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
import NpmLikeInstallation from '@/mdx-components/NpmLikeInstallation';

import Checkpoint from '../../fragments/_checkpoint.md';
import RedirectUris from '../../fragments/_redirect-uris-web.mdx';

Expand All @@ -15,29 +15,8 @@ import RedirectUris from '../../fragments/_redirect-uris-web.mdx';
subtitle="Install Logto SDK and required dependencies"
>

<Tabs>
<TabItem value="npm" label="npm">

```bash
npm i @logto/express cookie-parser express-session
```

</TabItem>
<TabItem value="yarn" label="Yarn">

```bash
yarn add @logto/express cookie-parser express-session
```

</TabItem>
<TabItem value="pnpm" label="pnpm">
<NpmLikeInstallation packageName="@logto/express cookie-parser express-session" />

```bash
pnpm add @logto/express cookie-parser express-session
```

</TabItem>
</Tabs>
</Step>

<Step
Expand Down Expand Up @@ -125,4 +104,3 @@ app.get('/', withLogto(config), (req, res) => {
</Step>

</Steps>

26 changes: 2 additions & 24 deletions packages/console/src/assets/docs/guides/web-next-app-router/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import { generateStandardSecret } from '@logto/shared/universal';
import NpmLikeInstallation from '@/mdx-components/NpmLikeInstallation';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
import Checkpoint from '../../fragments/_checkpoint.md';
Expand All @@ -13,29 +12,8 @@ import RedirectUrisWeb from '../../fragments/_redirect-uris-web.mdx';
subtitle="Install Logto SDK"
>

<Tabs>
<TabItem value="npm" label="npm">
<NpmLikeInstallation packageName="@logto/next" />

```bash
npm i @logto/next
```

</TabItem>
<TabItem value="yarn" label="Yarn">

```bash
yarn add @logto/next
```

</TabItem>
<TabItem value="pnpm" label="pnpm">

```bash
pnpm add @logto/next
```

</TabItem>
</Tabs>
</Step>

<Step
Expand Down
26 changes: 2 additions & 24 deletions packages/console/src/assets/docs/guides/web-next/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import Tabs from '@mdx/components/Tabs';
import TabItem from '@mdx/components/TabItem';
import NpmLikeInstallation from '@/mdx-components/NpmLikeInstallation';
import { generateStandardSecret } from '@logto/shared/universal';
import Steps from '@/mdx-components/Steps';
import Step from '@/mdx-components/Step';
Expand All @@ -13,29 +12,8 @@ import RedirectUrisWeb, { defaultBaseUrl } from '../../fragments/_redirect-uris-
subtitle="Install Logto SDK"
>

<Tabs>
<TabItem value="npm" label="npm">
<NpmLikeInstallation packageName="@logto/next" />

```bash
npm i @logto/next
```

</TabItem>
<TabItem value="yarn" label="Yarn">

```bash
yarn add @logto/next
```

</TabItem>
<TabItem value="pnpm" label="pnpm">

```bash
pnpm add @logto/next
```

</TabItem>
</Tabs>
</Step>

<Step
Expand Down
Loading
Loading