graphql-example icon indicating copy to clipboard operation
graphql-example copied to clipboard

Errors Installing, Missing Documentation

Open fireproofsocks opened this issue 8 years ago • 1 comments

This looks like a promising package so I wanted to give it a try.

It would be helpful to include a section in your documentation on "Installation". I tried running the suggested npm install graphql-example, but that doesn't work. I only have limited experience with node and npm, but it looks like you have to first initialize a directory before you can install node packages to it. At least, I think that's the intention -- from the description it's not clear if this is supposed to be a plugin for an existing framework like Express, or if this project runs on its own. It would be helpful if the description described this package in a bit more detail (you probably don't need to try and explain GraphQL).

Secondly, I'm confused by the note that this requires Node v7+... the Node Download Page says the latest version is 6.11.4... but their "Previous version" page at https://nodejs.org/en/download/releases/ lists version 8, so I'm seriously confused on what planet the Node versioning people are on. A note in your installation instructions would be helpful.

Next, npm start does not appear to work: npm ERR! missing script: start

Probably I installed something incorrectly (?)

Finally, I would suggest keeping the nodemon stuff separate. I have never gotten it to work (the problem may lie with Dropbox?), but regardless, nodemon adds a whole other layer of complexity on top of the package that is unnecessary for evaluation purposes. It's nice to show an option for how to use nodemon, but for me, it's just one more thing that doesn't work properly and prevents me from actually trying out your package.

Thanks for hearing me out on this long issue report.

fireproofsocks avatar Oct 07 '17 21:10 fireproofsocks

Hey, this package needs to be upgraded. Sorry ... I'll do that as soon as I get 5min of free time ;). In the meantime, please check the https://github.com/xpepermint/rawmodeljs/ package.

xpepermint avatar Oct 07 '17 21:10 xpepermint