Skip to content

Feature request: Make getting started UX better #14

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

Open
riywo opened this issue May 3, 2025 · 0 comments
Open

Feature request: Make getting started UX better #14

riywo opened this issue May 3, 2025 · 0 comments
Assignees

Comments

@riywo
Copy link
Contributor

riywo commented May 3, 2025

Problems

Currently, the initial setup isn't user friendly. The user needs to create a directory and setup environment variable by hand. README doesn't cover Windows setup.

Values

  • A new user can setup Aethr by one interactive command
    • Only the prerequisite is Node.js installation but eventually we can provide a script installer

Solution

  • Create create-aethr package
    • npm init aethr@latest is the initialization command
  • Use @inquirer/prompts to collect inputs from the user interactively
    • Support non-interactive setup as well (nice-to-have at the beginning)
  • Setup a workspace directory, .env, aethr.config.mjs and a demo scenario
  • Then, the user can simply get started by npx aethr run demo.md
@riywo riywo self-assigned this May 3, 2025
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

No branches or pull requests

1 participant