commit 96b8d94ab3ed2bc35d0919e12fd24f97e578ed74 Author: Javier Cicchelli Date: Sun Apr 23 22:37:22 2023 +0000 Add 'Environment variables' diff --git a/Environment-variables.md b/Environment-variables.md new file mode 100644 index 0000000..1497098 --- /dev/null +++ b/Environment-variables.md @@ -0,0 +1,21 @@ +The content of the environment files used in this project is being defined in this page, as it is not possible to upload files to this wiki. + +In case of doubt, these files must be located at the root of the projecy and, of course, they should not included into the repository, as it is not recommended to put any credentials into the repo itself. + +`.env` + +```env +# -- PROJECT --- + +SWIFT_TARGET_NAME=AmiiboService + +# --- DOCUMENTATION --- + +SWIFT_DOC_FOLDER=./Documentation +SWIFT_DOC_GITHUB_OUTPUT=${SWIFT_DOC_FOLDER}/github +SWIFT_DOC_GITHUB_BASE_PATH=amiibo-service +SWIFT_DOC_PREVIEW_URL=http://localhost:8080/documentation/amiiboservice +SWIFT_DOC_XCODE_OUTPUT=${SWIFT_DOC_FOLDER}/${SWIFT_TARGET_NAME}.doccarchive + +``` +--- \ No newline at end of file