mehdi-gandomi/bamyan-electron-app

Ray's Nextron Template

---

Features

• Easy to build binaries thanks to electron builder#'
• Easy theming(styled-components & styled theming).
• Easy global state management.
• Typescript support(optional but preferred).
• Fully linted(with prettier and eslint).
• Global css using sass.
• Sass support.
• Css-in-js.
• Fast development with easy component,layout and state creation.
• Isolated scss with scss modules or styled components
• Easy dependency upgrading

Technologies used

• Electron
• NextJS
• RecoilJS
• Sass
• Css-in-js
• Styled-components
• Styled-theming
• Eslint
• Prettier

Scripts

Below are scripts that you can use to make development easier

Development

This runs the basic Next.js Server.

yarn dev

Building

This builds the files in to an end result.

yarn build

Linting

Below you can use both, however the eslint command is recommended before pushing to a repo. Eslint:

yarn eslint

or

Prettier:

yarn lint

Templates

You can easily create components, state or layouts using the templates provided. All you have to do is run these simple commands:

Components

yarn create:component <name>

Layouts

yarn create:layout <name>

States

yarn create:state <name>

Upgrading dependencies

You can easily upgrade the projects dependencies using:

yarn update:deps