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

DX: Explanations for what each remix-kit command do #21

Open
2 tasks done
cliffordfajardo opened this issue Dec 30, 2022 · 0 comments
Open
2 tasks done

DX: Explanations for what each remix-kit command do #21

cliffordfajardo opened this issue Dec 30, 2022 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@cliffordfajardo
Copy link
Collaborator

Description

As user using remix-kit, it would be nice to know what each of the remix-kit commands does

Example Scenario

  1. I create a new remix app (Remix App server)
  2. Setup remix-kit
> cd ./your-remix-app
> npx remix-kit@latest install

> npm run vite:dev
  1. I check the my package.json & see that there are new commands added to my scripts section:
    CleanShot 2022-12-30 at 10 11 57@2x

when should I use some of the commands over the other?

  • "vite:preview": "remix-kit preview", is straight forward IMO

but these other 3 are less straight forward:

  • "vite:dev": "remix-kit dev --origin http://localhost:3000",
  • "vite:preview": "remix-kit preview",
  • "dev:server": "remix-kit preview"

Questions

  1. Are "vite:preview" and ``"dev:server"` use the same shell command, is this intentional? I found it confusing seeing 2 different script commands that each call the same thing
  2. When would i use npm run vite:dev over npm run dev:server?

Suggested solution

Perhaps Adding documentation on each of the remix-kit commands, perhaps a table of when to use them
or
a new Remix CLI command that outputs what all the commands do in one STDOUT output

# we could link this in the README too
`npx remix-kit --help`

I think this is still useful:

npx remix [command] --help

Alternative

No response

Additional context

No response

Validations

  • Read the Contributing Guidelines.
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
@cliffordfajardo cliffordfajardo changed the title DX: Explanations for what each remix-kit command does DX: Explanations for what each remix-kit command do Dec 30, 2022
@cliffordfajardo cliffordfajardo self-assigned this Jan 3, 2023
@cliffordfajardo cliffordfajardo added the enhancement New feature or request label Jan 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant