Skip to content

Refine the UX around the project-create and Advanced Options => Local Docker Setup stages #898

@lasomethingsomething

Description

Run-through and observations

With version 0.12.1
It's possible to install the CLI using a simple one-step script or installer, but we've not documented the command.
Go here: https://developer.shopware.com/docs/products/cli/ to install (Homebrew)

Step 1. shopware-cli project create

Step 2. Select version

  • picked "(latest)"/top
  • Want to go back from the patch versions to "latest" but can't
  • Decide where/how introduce this in devdocs: could start from within the CLI docs folder until we want to "go Hollywood."
  • We have this page https://developer.shopware.com/docs/products/cli/project-commands/helper-commands.html but my first guess was not to look there
  • CLI folder does not have an index.md; would create one, post project create info there
  • Confirm: Will we need, at any time, to give users the option to check/adjust Node or other reqts? => As a dev, I want to easily install and adjust all required prerequisites (such as Node.js, Docker, Composer, and PHP) so that I can set up my development environment quickly and start working without friction."

Step 3. Select "Advanced Options"

  • chose "yes"
  • from options "None," "PaaS powered by Shopware", "PaaS powered by Platform.sh", "Deployer (SSH based zero-downtime) I chose "none"
    • should be "SSH-based"

This time I didn't have Docker running. Got a FATAL error (exit status 1). Kicked me out of the workflow. I started over.

Saw "Installing dependencies" with little timer icon. Nice. But this really takes a while.

Image

Step 4. "Select your CI/CD platform for automated testing and deployment"

  • from options "None," "GitHub Actions", and "GitLab CI" I chose "none"

Step 5. Optional: Select additional features to enable

  • From options "Initialize Git Repository", "Local Docker Setup", "AMQP Queue Support", "Setup Elasticsearch/OpenSearch support" I picked the Local Docker Setup
  • Got this (nice)
Image
  • ran cd louie && make up and docker compose up -d appeared; I see containers, they're green/healthy
  • ran make setup; "Nothing to install, update or remove/Generating optimized autoload files" hangs a while
    • spinny icon would be nice here ("is it stuck??")
  • in my terminal I see that I am now in my project, and I go to the devdocs and use http://localhost:8000/admin#/login/ -- it worked!
  • Would adjust to "Install Shopware with Local Docker Setup" so it's clear what I'm doing
    • maybe it should be the first option
  • At this stage (newcomer) I don't know why I would choose the other options; would need cues like how I adjusted Local Docker Setup
  • ==> "Set up Elasticsearch" (Set up = verb, setup = noun); would also indicate "for large catalogues and/or advanced search"

Step 6. Continue with "Start Developing" flow from DevDocs (sort of)

  • fold the devdocs step around accessing Admin and Storefront via http://localhost:8000/admin#/login/ and http://localhost:8000/ into the flow
    • resolve the issue with Storefront URL that takes me to error/"Sales Channel Not Found," caused by default setting in .env.local being APP_ENV=prod and not APP_ENV=dev
  • ran make shell
  • ran bin/console and got the long list of CLI commands
  • devdocs continue with Admin setup, and Install plugins or themes from the Store
  • I think this is the spot where we'll want to give folks a new round of options around "you have an empty project! Now A) create an extension (plugin=>plugin-based theme, y/no; or app); or then start working with APIs (drafting at Docs enhancements suggestions (WIP list) docs#2128 (comment))

From previous try/version

Step 2. WARNING shopware/core (>=6.7) blah blah popped up and I had to choose from this menu:

  • y → Add Docker setup (recommended)
  • n → Skip Docker setup
  • p → Always add for this project
  • x → Never add for this project

Metadata

Metadata

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation
No fields configured for Improvement.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions