Urigo / graphql-cli

📟 Command line tool for common GraphQL development workflows

Home Page:https://graphql-cli.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Onboarding improvement

jycouet opened this issue · comments

commented

Hi there,

I guess that one aim of a cli is to facilitate adoption of a technology. In this case, graphQL.
I see great potential there, to onboard people... but not in doing everything in one shot! For one shot, it would be more efficient with a boilerplate... you clone, don't really understand what you do and it's working.

Here, the point is to go step by step and understand what is going on. It's almost as fast as cloning a repo... But you will, in addition, understand why and what are you doing.

That's why I suggest to keep it simple in the README.md

npx graphql-cli@next init

The rest is guided by cli questions...
At the end of this init process, you have then a good skeleton of an app. Next step is to follow a few steps (in the README.md of your new project) to have something running.
To understand each step, you need to know what cmd is affecting what file.
That's why I suggest having an empty skeleton and generate files after files... and really see/understand how the app is building itself cmd after cmd.

Also, I suggest to git init after the graphql-cli init to be able to see "live" your files changing.
Having this kind of view (thx to VSCode):
image

What are your thoughts?

commented

I don't know when this was done, but I see that git is not initialized after the init!
Well done :)