StefMa / Geist

Geist

Details

Geist is an easy to use upload tool. It use Firebase Storage to store files in the cloud.

Features

See this article on Medium.

Setup

Before you start you need to follow these steps to setup Geist correctly.

1. Create a Geist Server instance (See Geist Server Setup).
2. Replace the $YOUR_🔥BASE_PROJECTID with your Firebase Project Id in main.js
3. Build Geist.
4. Create a User. Run Geist, open the Tray -> Settings and click sign up.

How to build

What is needed

• Homebrew to install "build tools"
• yarn to build and distribute

Can be installed via brew install yarn

• ffmpeg to convert videos to gifs

Can be installed via brew install ffmpeg

Build

1. Check What is needed
2. Clone the repo
3. yarn install
4. node_modules/.bin/electron .
5. Smile! \o/

Build a release

To build a release just run

yarn run distribute

This will build a .app, .zip & .dmg file into the dist/mac directory. Actually it builds for mac x64.

This will also remove the App from the recent window (tab switcher).

Note: You can also build a single .app file with yarn run pack

Update/Release

Version

If we update it is mandatory to update the version inside the package.json.

The version number should follow these specs.

GitHub Release

After we published we have to create a GitHub Release.

For that we needed a tag which will be named as release/vX.X.X. The X.X.X represent the version we specified with the step above.

It is also necessary to add a changelog.

Credits

• aperture - For this awesome screen recoding tool
• Kap - For making Kap open source! I've looked for some stuff how they implemented it. That have helped me a lot with this project! Thank you ❤️.
• milan.kohu - For this awesome icon.