Skip to content

Latest commit

 

History

History
86 lines (52 loc) · 2.83 KB

README.md

File metadata and controls

86 lines (52 loc) · 2.83 KB
Raw

Time Track

Coverage Status

About

Time Track is a program primarily written for All American Concrete Inc. It is designed to document employee cost.

Purpose

The reason for this accumulation of data is to be more accurate in expense estimation in the pursuit of efficiency.

Usage

Coming soon! This is in the works

Releasing new Electron version of Desktop app

Prerequisites (one-time instruction)

  1. Add GH_TOKEN to your environment based on the instructions in electron-builder's docs.

  2. Install yarn:

    npm install --global yarn

  3. For creating a release you'd need both Windows and Mac machines.

Creating new release

  1. Make sure to pull recent master.

  2. Switch to the desktop folder.

  3. Delete all node_modules folder. This step is needed for yarn to run correctly after pnpm or npm was used.

    rm -rf node_modules

  4. Run yarn to install node_modules back:

    yarn

  5. Update version in desktop/package.json (do not commit yet)

  6. Build the electron app using the following commands.

    • On Windows:
    yarn run dist-win
    • On Mac:
    yarn run dist-mac

    If the commands above complete successfully, there will be a Draft release created in the project's Releases section.

  7. Check if the application runs correctly. Open the Releases section, find a Draft release. In its Assets section, download and install the draft version of the app and make sure it works. After you are done, install a previous version of the app, to check the autoupdate later.

  8. Open the Releases section, find a Draft release and click Edit button.

  9. Write releas notes, or use auto-populate. Publish the draft release.

Testing auto-update

  1. Install and run locally the previous version.

  2. Open a log file (you can do it in the browser, by navigating to the file path). Logs is located at %AppData%\timetrack\log.log

  3. Close out TimeTrack locally

  4. Run TimeTrack and make sure it shows the upgrade notification. You might need to restart it to get a new version.

Updating a version in desktop/package.json

After completing all the steps above, bump the patch version in the desktop/package.json file, submit and merge it as a new PR.

Help

For more usage help try my website, or my email([email protected])

Cheers!
Josh