Fibtero
Roadkill beaver. A custom Jira reader.
Based on vite-electron-skeleton
.
Setup
- clone the repo
npm install
- Generate a Jira API key: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account
- Figure out the domain name for your Jira Cloud instance. Example:
<company-name>.atlassian.net
- Get your username (should be a full email)
- Run
npm start
, fill in the fields.
Code arrangement
All source code is in packages
.
packages/common
: code shared between all packagespackages/jest
: jest (testing) configpackages/main
: backend for the Electron app.packages/preload
: part of the backend for the Electron app.packages/renderer
: frontend for the Electron app.packages/scripts
: collection of scripts that can be run directly.
Dev
npm run start
: startup developer Electron app that auto-refreshes when changes are detected.npm run compile
: output an executable/app for the current system into the/dist
directory.npm run type-check
: run TypeScript type checking for all packages.npm test
: run tests.npm run test:full
: run all configured tests (including spellchecking, type checking, etc.).npm run format
: format all code.
Tested on Node.js 16
.