A boilerplate for rapid application development using Electron or Web built around React and Typescript.
This project uses as base the electron-react-typescript-boilerplate and takes inspiration from other projects like create-react-app, and then I changed some things to fit my personal tastes.
-
Install node (Last tested on 8.11.4) #Skip if you already have Node installed
go to https://nodejs.org/en/ download and install node.
-
Install Git #Skip if you already have Git installed
go to https://git-scm.com/downloads download and install git.
-
Clone the project
git clone https://github.com/TPessanha/ElectronBoilerplate.git. -
Install dependencies
npm install -
Run app
npm start
The following technologies are the main ones included in this boilerplate, click on each to learn more:
| Dependency | Description |
|---|---|
| Webpack | A module bundler. Its main purpose is to bundle JavaScript files for usage in a browser, yet it is also capable of transforming, bundling, or packaging just about any resource or asset. |
| React | A JavaScript library for building user interfaces. |
| Redux | Redux is a predictable state container for JavaScript apps. |
| React-Router | React Router is a collection of navigational components that compose declaratively with your application. |
| Typescript | TypeScript brings you optional static type-checking along with the latest ECMAScript features. |
| Jest | Jest is a testing library for JavaScript code including React applications. |
| Babel | Babel is a free and open-source JavaScript compiler and configurable transpiler used in web development. |
| Electron | Babel is a free and open-source JavaScript compiler and configurable transpiler used in web development. |
| ESLint | A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript. Maintain your code quality with ease. |
| TSLint | An extensible linter for the TypeScript language. |
| Prettier | An opinionated code formatter. |
| Sass | Sass is the most mature, stable, and powerful professional grade CSS extension language in the world. |
| Lodash | A JavaScript utility library delivering consistency, modularity, performance, & extras. |
Check out the documentation for more.