Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 2.35 KB

README.md

File metadata and controls

74 lines (52 loc) · 2.35 KB
Raw

DEPRECATED

⚠️ Devbook app is officially deprecated. We keep servers running for now but there won't be any new features. ⚠️

👉 Check out the new SDK we are working on.

Devbook

The app has two parts.

  • The client part. That's the frontend of the app that is done in React. Client is distributed through the CDN https://client.usedevbook.com/<version>. The electron part then loads it's content from this URL. The version in the URL must match the version of the app.
  • The electron part. This is the actual app that is turned into binary format and distributed into users' machines.

Performance monitoring

How to monitor Electron

  1. Run npm run start:inspect command.
  2. Open Google Chrome and go to the chrome://inspect/#devices location.
  3. Under the "Remote Targets" section click on the "inspect" under the "Target (v14.16.x) electron/js2c/browser_init" device.
  4. If you want to unpause the app (--inspect-brk flag paused it) go to the "Sources" page in the opened Dev Tools and click on the "Resume script execution" button.
  5. You can now profile and inspect the running app.

How to build

We use ToDesktop for building and releasing.

Run npm run build:electron to build macOS, Windows, and Linux versions WITHOUT CODE SIGNING. The code signing takes cca 15 minutes, so you don't want to code sign if you are just testing the build. You won't be able to release this build.

Run npm run build:electron:prod to build macOS, Windows, and Linux versions WITH CODE SIGNING.

How to release

Go to https://app.todesktop.com/apps/2102273jsy18baz, and click on the "Release" button in the corresponding successful build.

Local development

npm run start

Deploy to staging

You must deploy the client and electron part separately.

  1. Bundle client
npm run bundle:client:staging
  1. Deploy client to the staging CDN
npm run deploy:client:staging
  1. Build electron (unsigned build)
npm run build:electron:staging
  1. Download the build from ToDesktop

Deploy to production

You must deploy the client and electron part separately.

  1. Bundle client
npm run bundle:client:prod
  1. Deploy client to the production CDN
npm run deploy:client:prod
  1. Build electron (signed build)
npm run build:electron:prod
  1. Download the build from ToDesktop