Giter Site home page Giter Site logo

fibtero's Introduction

Fibtero

Roadkill beaver. A custom Jira reader.

Based on vite-electron-skeleton.

Setup

  1. clone the repo
  2. npm install
  3. Generate a Jira API key: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account
  4. Figure out the domain name for your Jira Cloud instance. Example: <company-name>.atlassian.net
  5. Get your username (should be a full email)
  6. Run npm start, fill in the fields.

Code arrangement

All source code is in packages.

  • packages/common: code shared between all packages
  • packages/jest: jest (testing) config
  • packages/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.

fibtero's People

Contributors

chayston avatar electrovir avatar mperez-lucid avatar

Watchers

 avatar  avatar  avatar  avatar

fibtero's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.