Skip to content

gregoranders/typescript-react-electron-starter

Repository files navigation

TypeScript React Electron Starter

This project is an application skeleton for an Electron application using React written in TypeScript.

Dependency Status License Issues Code maintainability Code issues Code Technical Debt

Codacy Badge

Main Language Languages Code Size Repo-Size

Features

  • TypeScript
  • Jest Unit Tests with Code Coverage
  • GitHub CI Integration (feature, development, master, release)
  • Travis Integration
  • CircleCI Integration
  • AppVeyor Integration
  • Code Quality via Code Climate and Codacy
GitHub Travis CircleCI AppVeyor Coveralls
ReleaseMaster Build Release
Master Build Master Build Master Build Master Build Master Coverage Master Version
Development Build Development Build Development Build Development Build Test Coverage Development Version

Clone repository

git clone https://github.com/gregoranders/typescript-react-electron-starter

Install dependencies

npm install

Build

Build Electron Application

npm run build

Testing

Test using Jest

npm test

Test using Spectron

Screenshots will be located in ./it/screenshots.

npm run e2e

Run

npm start

Clear

npm run clear

Code Climate Checks docker required

npm run codeclimate

Platform distribution

Package will be located in ./dist/pkg.

npm run dist