Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boly38/electron-reactjs-boilerplate
Javascript ReactJS App with boilerplate as exe packager
https://github.com/boly38/electron-reactjs-boilerplate
Last synced: 2 days ago
JSON representation
Javascript ReactJS App with boilerplate as exe packager
- Host: GitHub
- URL: https://github.com/boly38/electron-reactjs-boilerplate
- Owner: boly38
- Created: 2024-02-17T16:46:56.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-02-19T13:05:45.000Z (8 months ago)
- Last Synced: 2024-04-15T09:07:01.822Z (6 months ago)
- Language: JavaScript
- Size: 474 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# electron-reactjs-boilerplate
## Object
- give a ready to use stack of
- ReactJS front-end,
- electron-based `.exe` packaging
- API and service based backend using node-dependency-injection
- note that if you want to use Typescript based boilerplate,
your could checkout [electron-react-boilerplate/electron-react-boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate)
## Usage
### install
To start only one time
````
git clone https://github.com/boly38/electron-reactjs-boilerplate.git
cd electron-reactjs-boilerplate
npm install && cd front-end && npm install && cd ..
````
### dev
- run this to develop front-end:
````
npm run dev:front-end
npm run start-from-src
# dont use app but your browser and open http://localhost:3000
````
- run this to build front-end and check executable app with it:
````
npm run start
````
- run this to re-run executable app without change on front-end (suppose you've built it in the past):
````
npm run start-from-src
````
### test
````
npm run test
````
### package
- run this to build an executable and setup package:
````
npm run package
````
### reminder
In order to get tips: the way to unpack asar content, get last exe, get last setup.
````
npm run howto:unpack-binary
npm run howto:run_unpacked_exe
npm run howto:run_setup
````
## FAQ
- why the executable size is so huge (~80/100MB) ?
IDK exactly but electron embeds chromium and there is some cost related to this statement.
- does exist alternative to electron to package a RectactJS application ?
Sure but there is a need to validate them: [pkg](https://github.com/vercel/pkg) (archived) - [NodeJS 21 single executable application](https://nodejs.org/api/single-executable-applications.html) - [nwjs](https://github.com/nwjs/nw.js) and probably more...
## Contribute
You're welcome to push PR, questions or issue. Dont hesitate to be critic on existing content if you could suggest better.