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

chore: make demo readme more clear for new developers #974

Merged
merged 3 commits into from
Oct 2, 2024
Merged

chore: make demo readme more clear for new developers #974

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fdb1368
chore: make demo readme clear for new developers
rthomare Sep 19, 2024
c7e4b8f
Merge branch 'main' into rohan/chore/updateDemoReadme
rthomare Oct 1, 2024
72bf82f
Merge branch 'main' into rohan/chore/updateDemoReadme
rthomare Oct 2, 2024
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
30 changes: 22 additions & 8 deletions examples/ui-demo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,31 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).

## Getting Started
# Getting Started

First, run the development server:
## Setup your Environment
1. Ensure you have the right node version corresponding to the `/aa-sdk/.nvmrc` file.
2. Go to Alchemy's Dashboard, and set up an [account config](https://dashboard.alchemy.com/accounts/config/create).
1. For local development set the configuration with a redirect url to http://localhost:3000.

## Install Dependencies
*In the root `/aa-sdk/` directory*

```bash
yarn install
```

## Build the aa-sdk Libraries
*In the root `/aa-sdk/` directory*

```bash
yarn build
```

## Start the Server
*In the ui-demo `/aa-sdk/examples/ui-demo` directory*

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

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
Expand Down
Loading