Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hi-ray/electron-next-template
A minimal nextjs electron template.
https://github.com/hi-ray/electron-next-template
Last synced: 8 days ago
JSON representation
A minimal nextjs electron template.
- Host: GitHub
- URL: https://github.com/hi-ray/electron-next-template
- Owner: Hi-Ray
- Created: 2021-08-13T10:13:52.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T10:09:28.000Z (almost 2 years ago)
- Last Synced: 2023-03-04T10:09:48.367Z (almost 2 years ago)
- Language: TypeScript
- Size: 1.55 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 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](https://www.electronjs.org/)
- [NextJS](https://nextjs.org/)
- [RecoilJS](https://recoiljs.org/)
- [Sass](https://sass-lang.com/)
- [Css-in-js](https://cssinjs.org/?v=v10.7.1)
- [Styled-components](https://styled-components.com/)
- [Styled-theming](https://www.npmjs.com/package/styled-theming)
- [Eslint](https://eslint.org/)
- [Prettier](https://prettier.io/)
## Scripts
**Below are scripts that you can use to make development easier**
### Development
This runs the basic Next.js Server.
```shell
yarn dev
```
### Building
This builds the files in to an end result.
```shell
yarn build
```
### Linting
Below you can use both, however the eslint command is recommended before pushing to a repo.
**Eslint:**
```shell
yarn eslint
```
or
**Prettier:**
```shell
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
```shell
yarn create:component
```
### Layouts
```shell
yarn create:layout
```
### States
```shell
yarn create:state
```
## Upgrading dependencies
You can easily upgrade the projects dependencies using:
```shell
yarn update:deps
```