govindrai / LPN-Fitness-App

Helps organizations take charge of their people's well being and promote healthier lifestyles through fitness competitions. Built on Node.js
https://lpnfitness.herokuapp.com/
0 stars 0 forks source link

Add instructions for developer if devkeys.js is not found #94

Closed govindrai closed 5 years ago

govindrai commented 5 years ago

When running locally, necessary keys for remote assets are refererenced from a devkeys.js file, but if you've just cloned the repo, your build fails because you don't have a devkeys.js file. On top of that, if you haven't been using the repo, you don't really know what goes in the devkeys.js file. This PR should add a devkeys.js file with dummy variables, remove devkeys.js from the gitignore, check it into the repo, then add devkeys.js back into the gitignore.

govindrai commented 5 years ago

As it turns out, you can't ignore a file once it's part of the repo, even if it added to the gitignore. This would just always bring up devkeys.js as a modified file under git status, which would be highly annoying and every once is a while, you will accidentally end up committing it. A better approach is to just warn the user when the devkeys.js is not created and offer helpful instructions.