diff --git a/README.md b/README.md index 537d30f8f..a8e0ad654 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,14 @@ GOOGLE_CLIENT_SECRET= [podman-compose](https://github.com/containers/podman-compose) is used to run a local copy of all required services together. + + +macOS Development Setup - If you're working on macOS and encounter issues with file watching in Vite, use the following environment variables (in config.env): + +``` +CHOKIDAR_USEPOLLING=true +``` + ```shell # This will run podman-compose in the background (-d flag is --detach) podman-compose up -d diff --git a/config.env.example b/config.env.example index d30315c44..da15fce36 100644 --- a/config.env.example +++ b/config.env.example @@ -18,6 +18,10 @@ ORCID_API_ENDPOINT=https://api.sandbox.orcid.org GLOBUS_CLIENT_ID= GLOBUS_CLIENT_SECRET= +# macOS Development Setup - Fixes issues with Vite file watching - set to CHOKIDAR_USEPOLLING=true +CHOKIDAR_USEPOLLING=false +CHOKIDAR_INTERVAL=1000 + # Relay for enabling mail - leave blank to disable email CRN_SERVER_MAIL_API_KEY= CRN_SERVER_MAIL_API_SECRET=