Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 1.57 KB

DOCS.md

File metadata and controls

60 lines (38 loc) · 1.57 KB
Raw

Dev Docs

this is a Electron project bootstrapped with Electron React Boilerplate.

in a nutshell its a GUI that interacts with warp-plus binary and changes system proxy setting.

Getting Started

  1. make sure you have node and npm installed.

  2. clone this repo

  3. install packages

npm install
  1. run the development server
npm run dev # or npm start

Packaging for Production (build from the source)

To package for the local platform:

npm run package

for faster production build (test purposes) use one of the following:

npm run package:linux
npm run package:windows
npm run package:mac

when commands finish you shall have your production build(s) at: release/build

for more specific builds checkout: https://www.electron.build/cli

IPC (sending data between main and renderer)

as you may be familiar with electron already.
we need to use IPC in order to send and receive data between main and renderer.
checkout src/main/ipc.ts and src/renderer/index.tsx for an in action example.

Notes

  • (after wp updates) to get the latest wp version, that app is using. run: npm i.
  • wp refers to warp-plus in source.
  • od refers to oblivion desktop in source.

happy hacking 😉