search

carbon-io / carbond

MIT License
2 stars 5 forks source link

Example apps dont mention how to install aglio #218

Closed willshulman closed 6 years ago

tfogo commented 6 years ago

Building docs only seems to work if I install aglio locally - is that expected bahaviour?

tfogo commented 6 years ago

@rmiyashiro Do you have any ideas about this?

It only works if I run npm i aglio. Doing npm i -g aglio won't work. It will throw:

ERROR: Aglio is not installed. Please run `npm install aglio` manually to enable Aglio doc generation
rmiyashiro commented 6 years ago

I believe this speaks to the issue: https://stackoverflow.com/questions/15636367/nodejs-require-a-global-module-package

What is your NODE_PATH variable set to?

tfogo commented 6 years ago

Ah great! My NODE_PATH is undefined so it looks like that's the issue.

However, the Node and npm docs seem to indicate we shouldn't be requiring global modules anyway. So for the examples, should we just tell them to run npm i aglio?

For those of us working on examples a lot, we may want to install aglio globally to spare ourselves the many hours waiting for aglio to build... but it is probably better practice to have people install aglio locally for the examples, perhaps as a devDependency. Thoughts?

tfogo commented 6 years ago

If nobody has any strong feelings against it, I'm going to add to the documentation that users should run npm install -D aglio to install it locally as a devDependency.

willshulman commented 6 years ago

@tim let's discuss live at today's mtg

tfogo commented 6 years ago

Outcome of the meeting: Suggest people to run npm install -D --no-optional aglio.

tfogo commented 6 years ago

Info has been added to all 0.7 versions of the examples