Troubleshooting
Inspecting Errors
When running any of the npm run dev commands you may encounter errors. These may display over the window itself or may may exist in the developer tools. These tools can be accessed by right clicking the window and selecting "Inspect" or by pressing Ctrl+Shift+I (Cmd+Option+I on Mac). The errors, as well as any console.logs, will be displayed in the "Console" tab of the developer tools.
When developing Electron apps there are two processes: main, and renderer. In this case, main corresponds to public/electron/main.js and its console is in the terminal where npm run devwas run. renderer corresponds to the React App - this is everything else. This console can be found using the same steps as above - note that running npm run dev should open the developer console by default.
Common issues
Installing Dependencies
Brew Not Available
If you run into issues installing Homebrew in step 1 of Installing Prerequisites it may be because Homebrew is not available on your shell. Older versions of macOS (under 10.14) do not do this automatically.
Run the following command to manually add the Homebrew installation location to your PATH so it is available in your shell.
echo 'PATH="/usr/local/bin:$PATH"' >> ~/.bash_profile
If you're using zsh, also add to your ~/.zshrc file.
NPM Errors
Most npm issues can be resolved by re-installing dependencies. This can be done by running the following commands in the root directory of the project:
- Delete the
node_modules/folder - Delete hte
package-lock.jsonfile - Reinstall dependencies
npm install