CrewTimer Video Review

CrewTimer Video Review is built using Electron, and specificlly the Electron React Boilerplate Project.

Development Environment Setup

Node version 16 or later is recommended.

Visual Studio Code is the recommended IDE for editing code for this repo. If you don't have it installed, please do that first.
The nvm node version manager is recommended to manage node versions. Node.js which includes npm is required for local development.
Source code utilizes git. If you are unfamiliar with git, the Atlassian Sourcetree program provides a nice GUI as does Github Desktop.

Quickstart

nvm install 16
nvm use 16
git clone git@github.com:crewtimer/crewtimer-video-review.git
yarn install
yarn start

If the build fails with a node-gyp error, be sure node-gyp is installed globally.

The crewtimer_video_reader native module contains pre-built binaries for mac and win targets. If this repo is private, a github token is required to retrieve the pre-built binaries.

Obtain your github token
Add it to ~/.prebuild-installrc
e.g. token=ghp_8bh6rSO2EhGf3nVCgY4GrEvs1dqd324

Installation and Configuration Notes to self

MacOS can build for all targets - mac, win, linux

To build native libs (sqlite3) a recent version of npm is needed.

Run nvm ls-remote --lts and pick a version. 16 known to work.
Install nvm install 16
Use it nvm use 16
Make it default nvm alias default v16
Update node-gyp npm i -g node-gyp@latest". Required to build sqlite3.
Install yarn npm i -g yarn
Install ts-node npm i -g ts-node
Some report needing this: npm config set node_gyp "/usr/local/lib/node_modules/node-gyp/bin/node-gyp.js
Add sqlite3 to release/app/package.json instead of top level. cd release/app && npm i --save sqlite3
For firebase, edit webpack.config.renderer.dev.dll.ts and modify renderer field entry: { renderer: Object.keys(dependencies || {}).filter((it) => it !== 'firebase'), }, . See stackoverflow for issue it resolves.
In resolve: section of , add fallback: { path: require.resolve('path-browserify'), }, to make path available from the renderer.

Native modules

A native module is used to read mp4 files from storage using the ffmpeg library. This code is prebuilt and stored on github.

To make updates to the native code, see Instructions for the native video reader. Access to both a windows and Mac is required.

Debugging

Starting from VSCode seems broke. Try this command line

yarn "start:main" "--inspect=5858" "--remote-debugging-port=9223"

Open dev window with releases code:

yarn cross-env DEBUG_PROD=true yarn package

File Locations

Windows

CrewTimer.db No longer correct: C:\Users\glenne\AppData\Local\Programs\crewtimer-fl-connector\CrewTimer.db
Images and assets C:\Users\glenne\AppData\Local\Programs\crewtimer-fl-connector\resources\assets
config.json C:\Users\glenne\AppData\Roaming\CrewTimer Video Reviewor\config.json

MacOS

CrewTimer.db '/Users/glenne/Library/Application Support/Electron/CrewTimer.db'
config.json debug: '/Users/glenne//Library/Application Support/Electron/config.json'
config.json installed: '/Users/glenne//Library/Application Support/crewtimer-fl-connector/config.json'

Releasing new versions

Edit release/app/package.json and src/renderer/Nav.tsx and adjust version info
Execute npm run winbuild
Look in release/ for the exe file
Copy the exe to the 'CrewTimer Installers' google drive folder.
Make a copy of the installer and rename it without a version: CrewTimerConnect Setup.exe.

Tips

Blank screen at startup? Check to make sure packagse were added top level package.json
Speedsoft Time Sync
Use Meinberg NTP

crewtimer / crewtimer-video-review

readme