This commit is contained in:
KorbsStudio 2023-01-25 03:26:29 -05:00
parent c776932cc0
commit 3464eb63b7
No known key found for this signature in database
4 changed files with 53 additions and 20 deletions

View file

@ -40,8 +40,13 @@ ___
## In Development
The following features are planned:
- Notification System*
- System Preference Respect**
- Notification System
- System Preference Respect [What's this?]()
- Progress indicators
- Deep Links
- Light Theme [Why?]()
- Skeleton State [What's this?]()
- Splash
- Components for:
- Sidebar
- Notifications
@ -49,13 +54,42 @@ The following features are planned:
- Overlays
- Settings
`*` This is subject to change
**What do you mean by System Preference Respect?**
_This is currently in writing, check back later..._
`**` Help Wanted
**Why Add Light Mode?**
_This is currently in writing, check back later..._
**What is Skeleton State**
_This is currently in writing, check back later..._
___
# Working in Nexus Polestar
## Branding
Of course, you can't distribute the software to your customers with a placeholder logo and the name "Nexus Polestar". You'll obviously need to replace it with your company name and logo.
**App Name**
Replace "App Name" with something else like "COMPANY_NAME Desktop". As example, if your company was called BunnyJet, you would name it "BunnyJet Desktop".
You need to `App Name` in the following places:
```
- electron
- index.js
- build
- electron-builder.yml
```
Also, in the `electron-builder.yml` file, place update the App ID. As an example, if your company was called BunnyJet and your domain was BunnyJet.net, you would use `net.bunnyjet.bunnyjetdesktop`. Avoid using `-` in the app name as AppX seems to dislike it.
**Logo**
I highly recommend using the template file provided in the `/build` folder as it will help you follow the Apple and GNOME Human Interface Guidelines. The anme of file is `Nexus Polestsar - App Icon.penpot`, it's designed in [Penpot](https://penpot.app).
This template also provides the backgrounds for the DMG installer and the EXE setup. ([macOS Preview](https://i.imgur.com/t1oQFgd.png) / [Windows Preview](https://i.imgur.com/ftiXdoR.png))
![Apple Human Interface Guildlines](https://developer.apple.com/design/human-interface-guidelines/foundations/app-icons/images/app-icon-layout-guides.png)
![GNOME Human Interface Guildlines](https://developer.gnome.org/hig/_images/app-icon-sizes.svg)
## Building
The following is required on your workstation:
- NodeJS v16.12.0 and up

19
package-lock.json generated
View file

@ -1,11 +1,11 @@
{
"name": "nexus-polestar",
"name": "nexuspolestar",
"version": "1.0.0",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "nexus-polestar",
"name": "nexuspolestar",
"version": "1.0.0",
"license": "MIT",
"dependencies": {
@ -18,7 +18,7 @@
},
"devDependencies": {
"concurrently": "^7.6.0",
"electron": "^22.0.3",
"electron": "^23.0.0-beta.5",
"electron-builder": "^23.6.0"
}
},
@ -2932,12 +2932,11 @@
}
},
"node_modules/electron": {
"version": "22.0.3",
"resolved": "https://registry.npmjs.org/electron/-/electron-22.0.3.tgz",
"integrity": "sha512-eETrJTINTzlXgQrnJSrKiF2Xdt5EHpxZ6Kk+WUjFCE0zUztdVm+hrngUecqhj8TPFlYScTANzPwRwUIjOChl+g==",
"version": "23.0.0-beta.5",
"resolved": "https://registry.npmjs.org/electron/-/electron-23.0.0-beta.5.tgz",
"integrity": "sha512-djtjWdpqXJc7OZyyJa39F5UJhGiW2DeH3gHFLB3ysJGq6qhS2rg2cuq/2u0fvG6b/JTGp0MuLAlS+UoCK8tpSg==",
"dev": true,
"hasInstallScript": true,
"license": "MIT",
"dependencies": {
"@electron/get": "^2.0.0",
"@types/node": "^16.11.26",
@ -9954,9 +9953,9 @@
}
},
"electron": {
"version": "22.0.3",
"resolved": "https://registry.npmjs.org/electron/-/electron-22.0.3.tgz",
"integrity": "sha512-eETrJTINTzlXgQrnJSrKiF2Xdt5EHpxZ6Kk+WUjFCE0zUztdVm+hrngUecqhj8TPFlYScTANzPwRwUIjOChl+g==",
"version": "23.0.0-beta.5",
"resolved": "https://registry.npmjs.org/electron/-/electron-23.0.0-beta.5.tgz",
"integrity": "sha512-djtjWdpqXJc7OZyyJa39F5UJhGiW2DeH3gHFLB3ysJGq6qhS2rg2cuq/2u0fvG6b/JTGp0MuLAlS+UoCK8tpSg==",
"dev": true,
"requires": {
"@electron/get": "^2.0.0",

View file

@ -1,5 +1,5 @@
{
"name": "nexus-polestar",
"name": "nexuspolestar",
"version": "1.0.0",
"description": "",
"main": "./electron/index.js",
@ -11,7 +11,7 @@
"license": "MIT",
"devDependencies": {
"concurrently": "^7.6.0",
"electron": "^22.0.3",
"electron": "^23.0.0-beta.5",
"electron-builder": "^23.6.0"
},
"dependencies": {

View file

@ -1513,10 +1513,10 @@
"resolved" "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.284.tgz"
"version" "1.4.284"
"electron@^22.0.3":
"integrity" "sha512-eETrJTINTzlXgQrnJSrKiF2Xdt5EHpxZ6Kk+WUjFCE0zUztdVm+hrngUecqhj8TPFlYScTANzPwRwUIjOChl+g=="
"resolved" "https://registry.npmjs.org/electron/-/electron-22.0.3.tgz"
"version" "22.0.3"
"electron@^23.0.0-beta.5":
"integrity" "sha512-djtjWdpqXJc7OZyyJa39F5UJhGiW2DeH3gHFLB3ysJGq6qhS2rg2cuq/2u0fvG6b/JTGp0MuLAlS+UoCK8tpSg=="
"resolved" "https://registry.npmjs.org/electron/-/electron-23.0.0-beta.5.tgz"
"version" "23.0.0-beta.5"
dependencies:
"@electron/get" "^2.0.0"
"@types/node" "^16.11.26"