Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devbookhq/devbook-palette
DEPRECATED Search engine for developers
https://github.com/devbookhq/devbook-palette
docs electron javascript productivity search typescript
Last synced: 3 days ago
JSON representation
DEPRECATED Search engine for developers
- Host: GitHub
- URL: https://github.com/devbookhq/devbook-palette
- Owner: devbookhq
- License: other
- Created: 2020-11-24T10:24:43.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-22T04:40:18.000Z (almost 2 years ago)
- Last Synced: 2025-01-28T04:31:19.182Z (9 days ago)
- Topics: docs, electron, javascript, productivity, search, typescript
- Language: JavaScript
- Homepage: https://usedevbook.com
- Size: 10.4 MB
- Stars: 43
- Watchers: 6
- Forks: 7
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://usedevbook.com) 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/`. 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](https://www.todesktop.com/) 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
```
2. Deploy client to the staging CDN
```
npm run deploy:client:staging
```
3. Build electron (unsigned build)
```
npm run build:electron:staging
```
4. 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
```
2. Deploy client to the production CDN
```
npm run deploy:client:prod
```
3. Build electron (signed build)
```
npm run build:electron:prod
```
4. Download the build from ToDesktop