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

Improve CLI user experience & create continuity between control panel and CLI #1820

Merged
merged 20 commits into from
Dec 31, 2024

Conversation

bookernath
Copy link
Contributor

@bookernath bookernath commented Dec 30, 2024

What/Why?

  • Update CLI to use OCC APIs
  • Restructuring & simplifying code
  • Use new OCC client ID
  • Add sample data prompt
  • Create .catalyst file with store hash/access token after login action to be used for other CLI commands without re-prompting for login
  • Ensure CLI-created storefronts have the same end state in the control panel as storefronts created in the control panel
  • Various UX improvements like automatically opening the device auth URL

Testing

Create wizard (the extraneous log statement is not there in this actual PR)

createwizard.mov

Starting from app (I invalidated these credentials before posting this)

occ-to-cli.mov

Init command

init.mov

Copy link

changeset-bot bot commented Dec 30, 2024

🦋 Changeset detected

Latest commit: 7f665f9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@bigcommerce/create-catalyst Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Dec 30, 2024

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

Name Status Preview Comments Updated (UTC)
catalyst-latest ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 31, 2024 5:54pm
catalyst-soul ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 31, 2024 5:54pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
catalyst ⬜️ Ignored (Inspect) Dec 31, 2024 5:54pm
catalyst-au ⬜️ Ignored (Inspect) Visit Preview Dec 31, 2024 5:54pm
catalyst-uk ⬜️ Ignored (Inspect) Visit Preview Dec 31, 2024 5:54pm

Copy link
Contributor

@becomevocal becomevocal left a comment

Choose a reason for hiding this comment

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

Looks good. I just want to make sure we are thinking about the .env file makeup.

packages/create-catalyst/src/utils/config.ts Show resolved Hide resolved

if (this.config.auth?.storeHash && this.config.auth.accessToken) {
configObj.auth = {
storeHash: this.config.auth.storeHash,
Copy link
Contributor

Choose a reason for hiding this comment

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

Will the same store hash be in the main .env file and this config? If it is, do we need the store hash in both?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The utility of the .catalyst file is you can regenerate the .env.local, so it makes sense for it to have no dependencies on .env.local

@becomevocal
Copy link
Contributor

Appreciate the changes post review. Flow looks 🧈

@bookernath bookernath added this pull request to the merge queue Dec 31, 2024
Merged via the queue into main with commit 401417d Dec 31, 2024
12 of 14 checks passed
@bookernath bookernath deleted the cli-occ-apis branch December 31, 2024 18:01
@github-actions github-actions bot mentioned this pull request Dec 31, 2024
Copy link
Contributor

⚡️🏠 Lighthouse report

Lighthouse ran against https://catalyst-latest-9sa5wispd-bigcommerce-platform.vercel.app

🖥️ Desktop

We ran Lighthouse against the changes on a desktop and produced this report. Here's the summary:

Category Score
🟢 Performance 92
🟢 Accessibility 96
🟢 Best practices 100
🟠 SEO 82

📱 Mobile

We ran Lighthouse against the changes on a mobile and produced this report. Here's the summary:

Category Score
🟢 Performance 94
🟢 Accessibility 96
🟢 Best practices 100
🟠 SEO 85

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.

2 participants