search

cloudfoundry-community / node-cfenv

easy access to your Cloud Foundry application environment for node
Apache License 2.0
73 stars 20 forks source link

Local Configuration Documentation Could be Clearer #42

Closed suni-masuno closed 4 years ago

suni-masuno commented 4 years ago

After some substantial searching I have been unable to determine two things.

1) The name and location of the local settings file used. After some searching I did find an external article claiming it was env.json here https://www.tonyerwin.com/2014/10/nodejs-on-bluemix-easier-local.html 2) The format of the local settings file used. I attempted to immitate the format of https://github.com/cloudfoundry-community/node-cfenv/blob/master/tests/fixtures/vcap-local-good.json this file, but I cannot be sure if the reason I've yet to get it to work is wrong file name "env.json" or wrong formatting from that file.

A short section in the docs with "Local Config File Name, Path, and Format" would go a long way for me personally at least.

suni-masuno commented 4 years ago

Finally figured out how to hand in the vcapFile option (I had previously thought that was wrong due to poor formatting of the vcapFile itself).

So perhaps only the format needs to be more closely addressed in the docs.