rmccue / griffin

An email client.

Griffin

An email client.

Development

git clone https://github.com/rmccue/griffin.git
cd griffin
yarn install

# In three separate tabs:
# Build main (Node process)
yarn run start-main-dev

# Build renderer (browser process)
yarn run start-renderer-dev

# Run Electron and restart on main changes
yarn run start-electron-dev

Development on Windows

When running on Windows, WSL2 is required for your build environment.

After installing Griffin's dependencies and starting the main and renderer build process, you then need to install Electron as a Windows application.

The easiest way to do this is to download electron-v8.3.2-win32-x64.zip. Extract this to a directory somewhere (carefully, as it's a tarbomb; ensure you're cd'd into an empty directory if not using a GUI).

Once that's done, you can then start Electron with the following (inside a WSL2 shell):

# Set the path to the mounted path in WSL of the directory you extracted
# Electron to. This *must* be a mounted path from your Windows filesystem,
# otherwise Windows will prevent electron from running with obscure errors/
env ELECTRON_OVERRIDE_DIST_PATH=/mnt/f/Griffin/electron yarn run start-electron-dev:win

Note that nodemon is unable to quit Electron, so this command requires manual restarting of Electron on changes.

Credits

Incorporates work from Imapflow, licensed under the AGPL v3 or later. Copyright 2020 Andris Reinman.

Incorporates work from electron-react-typescript, licensed under the MIT license. Copyright 2018-2020 R. Franken.

Icon based on Griffin by Icons Producer from the Noun Project, licensed under CC-BY.