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

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rthomare
Copy link
Collaborator

@rthomare rthomare commented Sep 19, 2024

Pull Request Checklist


PR-Codex overview

The focus of this PR is to update the README.md file in the ui-demo directory with detailed setup instructions for the aa-sdk.

Detailed summary

  • Updated setup instructions for environment configuration
  • Added installation steps for dependencies
  • Included build instructions for aa-sdk libraries
  • Provided command to start the server for ui-demo

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

vercel bot commented Sep 19, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
aa-sdk-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 19, 2024 11:51am
aa-sdk-ui-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 19, 2024 11:51am

Comment on lines +14 to +20
npm install
# or
yarn install
# or
pnpm install
# or
bun install
Copy link
Collaborator

Choose a reason for hiding this comment

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

we use yarn everywhere so we should just have this be that

Comment on lines +27 to +33
npm build
# or
yarn build
# or
pnpm build
# or
bun build
Copy link
Collaborator

Choose a reason for hiding this comment

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

same here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants