josh/dashy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝 Adds env vars to development docs, updates readme badges

Browse Source
This commit is contained in:
Alicia Sykes
2021-09-09 18:12:30 +01:00
parent a442b3dbe2
commit 36a20621c8
3 changed files with 36 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/development-guides.md
View File

@@ -175,4 +175,13 @@ Finally, in the markup of your component, just add a `v-if` statement, referenci
</header>
```
---
---
## Adding / Using Environmental Variables
All environmental variables are optional. Currently there are not many environmental variables used, as most of the user preferences are stored under `appConfig` in the `conf.yml` file.
You can set variables either in your environment, or using the [`.env`](https://github.com/Lissy93/dashy/blob/master/.env) file.
Any environmental variables used by the frontend are preceded with `VUE_APP_`. Vue will merge the contents of your `.env` file into the app in a similar way to the ['dotenv'](https://github.com/motdotla/dotenv) package, where any variables that you set on your system will always take preference over the contents of any `.env` file.
If add any new variables, ensure that there is always a fallback (define it in [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js)), so as to not cause breaking changes. Don't commit the contents of your `.env` file to git, but instead take a few moments to document what you've added under the appropriate section. Try and follow the concepts outlined in the [12 factor app](https://12factor.net/config).