GitXplorerGitXplorer
S

Geist

public
3 stars
0 forks
6 issues

Commits

List of commits on branch master.
Unverified
3e974b7144cd8a38e7df40e24c6d32bfb12d5824

Update version

SStefMa committed 5 years ago
Unverified
36aca758c1bb435a70b45d56576b377cfbb42e79

Add version to readme

SStefMa committed 8 years ago
Verified
866837cf6f9665fee5306c8ef97444ae8e20c787

Merge pull request #12 from StefMa/updates

SStefMa committed 5 years ago
Unverified
2b44f5b136be75f4e4cf99594e31a1300994f15f

Update electron-builder

SStefMa committed 5 years ago
Unverified
0f50e7510dd42bc2b1671f48bf05821fc8324469

Enable nodeIntegration in cropperWindow as well

SStefMa committed 5 years ago
Unverified
23ab96852c36d7b748d8c2564f7925dfc88b5f5f

Update mime

SStefMa committed 5 years ago

README

The README file for this repository.

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. create a user

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.