Skip to content

Commit

Permalink
docs(account-settings): Account Settings intro docs (#3127)
Browse files Browse the repository at this point in the history
* Add intro contents

* trigger ci

* Update docs/src/pages/[platform]/connected-components/account-settings/index.page.mdx

* Update docs/src/pages/[platform]/connected-components/account-settings/index.page.mdx

* Update docs/src/pages/[platform]/connected-components/account-settings/index.page.mdx
  • Loading branch information
wlee221 authored Dec 5, 2022
1 parent ab10467 commit 6b30ffa
Showing 1 changed file with 36 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ description: Amplify UI provides account settings components to manage account s
supportedFrameworks: react
---

import { Alert, Tabs, TabItem } from '@aws-amplify/ui-react';
import { Fragment } from '@/components/Fragment';
import { InstallScripts } from '@/components/InstallScripts';
import { getCustomStaticPath } from '@/utils/getCustomStaticPath';
import { DeveloperPreview } from './DeveloperPreview';

Expand All @@ -21,7 +23,39 @@ export async function getStaticProps() {

<DeveloperPreview />

## Account Settings
Account Settings components are a set of standalone components that add [user management](https://docs.amplify.aws/lib/auth/manageusers/q/platform/js/) flows to your application with minimal boilerplate.

TODO
<Alert variation="warning">
Account Settings components require end user to be authenticated. You can use the [`Authenticator`](/connected-components/authenticator) component to add authentication UI to your application.
</Alert>

## Quick Start

### Step 1. Configure Backend

Account settings components work seamlessly with the [Amplify CLI](https://docs.amplify.aws/cli/start/install/)
to **automatically** work with your backend.

First, update `@aws-amplify/cli` with [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
if you're using a version before `6.4.0`:

<Tabs>
<TabItem title="npm">

```shell
npm install -g @aws-amplify/cli@latest
```

</TabItem>
<TabItem title="yarn">

```shell
yarn global add @aws-amplify/cli@latest
```

</TabItem>
</Tabs>

### Step 2. Install Dependencies

<InstallScripts />

0 comments on commit 6b30ffa

Please sign in to comment.