Skip to content

Commit

Permalink
style: organized some items and arrange format
Browse files Browse the repository at this point in the history
  • Loading branch information
julian-alarcon committed Jul 31, 2023
1 parent b0a7d6e commit c54fcdd
Show file tree
Hide file tree
Showing 14 changed files with 765 additions and 661 deletions.
8 changes: 6 additions & 2 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
# Lines starting with '#' are comments.

# Each line is a file pattern followed by one or more owners.

# More details are here: https://help.github.com/articles/about-codeowners/

# The '*' pattern is global owners.
# The '\*' pattern is global owners.

# Order is important. The last matching pattern has the most precedence.

# The folders are ordered as follows:

# In each subsection folders are ordered first by depth, then alphabetically.

# This should make it easy to add new rules without breaking existing ones.

# Global rule:
* @julian-alarcon

- @julian-alarcon
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
github: [julian-alarcon]
ko_fi: alarconj
ko_fi: alarconj
24 changes: 12 additions & 12 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
version: 2
updates:
- package-ecosystem: npm
directory: "/"
schedule:
interval: monthly
time: "10:00"
open-pull-requests-limit: 10
target-branch: main
versioning-strategy: increase-if-necessary
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: monthly
- package-ecosystem: npm
directory: "/"
schedule:
interval: monthly
time: "10:00"
open-pull-requests-limit: 10
target-branch: main
versioning-strategy: increase-if-necessary
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: monthly
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Build/release

on: [push,pull_request]
on: [push, pull_request]

jobs:
release:
Expand All @@ -18,7 +18,7 @@ jobs:
- name: Install Node.js, NPM and Yarn
uses: actions/setup-node@v3
with:
node-version: '20'
node-version: 20

- name: Install Snapcraft
uses: samuelmeuli/action-snapcraft@v1
Expand Down
60 changes: 30 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ The application can be downloaded from [here](https://github.com/julian-alarcon/

Select the appropriated file depending on your OS:

* Windows: `.exe` file or `.msi` file
* macOS: `.dmg` file
* Linux: Multiple artifacts are available, please choose your needed one (deb,
rpm, AppImage, snap, pacman) depending on your Linux Distribution.
- Windows: `.exe` file or `.msi` file
- macOS: `.dmg` file
- Linux: Multiple artifacts are available, please choose your needed one (deb,
rpm, AppImage, snap, pacman) depending on your Linux Distribution.

## Installation

Expand Down Expand Up @@ -57,52 +57,52 @@ For other distributions please follow your specific steps.
## Features

* Receive your Outlook Microsoft 365 online from the desktop app
* Close to minimize
* Start as minimized (you can use the Option in the Tray icon menu or start app with `prospect-mail --minimized`)
* Dock tray support
* System notification
* Connect to standard or custom outlook url
* Spellcheck using native Outlook MS Editor
- Receive your Outlook Microsoft 365 online from the desktop app
- Close to minimize
- Start as minimized (you can use the Option in the Tray icon menu or start app with `prospect-mail --minimized`)
- Dock tray support
- System notification
- Connect to standard or custom outlook url
- Spellcheck using native Outlook MS Editor

## Settings

* Via tray menu settings.json can be opened and edited. After every save you
need to click in "Reload settings" to apply changes.
- Via tray menu settings.json can be opened and edited. After every save you
need to click in "Reload settings" to apply changes.

```json
{
"urlMainWindow":"https://customurl.example/"
,"urlsInternal":["customurl.example"]
,"urlsExternal":["externalurls.example"]
,"showWindowFrame":true
"urlMainWindow": "https://customurl.example/",
"urlsInternal": ["customurl.example"],
"urlsExternal": ["externalurls.example"],
"showWindowFrame": true
}
```

As an example, this configuration will let you use Prospect with personal
Outlook.com account:

> Please notice that Prospect Mail is only tested in Work/Educational accounts
and no issues will be reviewed for personal accounts.
> and no issues will be reviewed for personal accounts.
```json
{
"urlMainWindow":"https://outlook.live.com/mail",
"urlsInternal":["outlook.com", "live.com"],
"urlsExternal":["outlook.com", "live.com"]
"urlMainWindow": "https://outlook.live.com/mail",
"urlsInternal": ["outlook.com", "live.com"],
"urlsExternal": ["outlook.com", "live.com"]
}
```

### Architecture components

The main software architecture components and their versions are this:

* [Node.js](https://nodejs.org/en/) version: 20.x
* [yarn](https://yarnpkg.com/) version: 1.22.x or newer
* [electron](http://electronjs.org/) version: 25.x
* [electron-builder](https://www.electron.build/) version: 24.6.x
* [electron-settings](https://github.com/nathanbuchar/electron-settings)
version: 4.0.2
- [Node.js](https://nodejs.org/en/) version: 20.x
- [yarn](https://yarnpkg.com/) version: 1.22.x or newer
- [electron](http://electronjs.org/) version: 25.x
- [electron-builder](https://www.electron.build/) version: 24.6.x
- [electron-settings](https://github.com/nathanbuchar/electron-settings)
version: 4.0.2

## Build

Expand Down Expand Up @@ -141,8 +141,8 @@ yarn run dist:mac

Once it was builded, or using the release files available, you can install the
files using [AppImage process](https://docs.appimage.org/user-guide/faq.html#question-how-do-i-run-an-appimage),
using .deb ```sudo dpkg -i prospect-mail_x.y.z_arch.deb``` or using the snap
file ```sudo snap install prospect-mail_x.y.z_arch.snap --dangerous```.
using .deb `sudo dpkg -i prospect-mail_x.y.z_arch.deb` or using the snap
file `sudo snap install prospect-mail_x.y.z_arch.snap --dangerous`.

## Release to Public

Expand All @@ -152,7 +152,7 @@ steps defined by [action-electron-builder](https://github.com/samuelmeuli/action
1. Define version in package.json. E.g. `0.4.0`
1. Add commit with changes. E.g. `git commit -am v0.4.0`
1. Tag the commit. E.g. `git tag v0.4.0`. Don't forget the `v` as suffix of the
version.
version.
1. Push changes including tags `git push && git push --tags`

## Manual release to Snapstore
Expand Down
11 changes: 5 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,11 @@
"base": "core22",
"plugs": [
"default",
"screen-inhibit-control",
"wayland",
"upower-observe",
"removable-media",
"cups",
"mount-observe",
"cups"
"removable-media",
"screen-inhibit-control",
"upower-observe"
],
"publish": [
"github",
Expand All @@ -105,7 +104,7 @@
"target": [
"dmg"
],
"icon":"build/icon.icns",
"icon": "build/icon.icns",
"type": "distribution",
"publish": {
"provider": "github",
Expand Down
54 changes: 27 additions & 27 deletions public/child-window.js
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
setTimeout(() => {
let removeTopBar = ['to-do.office.com/tasks']
let url = window.location;
let removeTopBar = ["to-do.office.com/tasks"];
let url = window.location;

// Remove Top Bar
if (new RegExp(removeTopBar.join('|')).test(url)) {
var topBar = document.querySelectorAll('#O365ShellHeader')
topBar[0].style.display = 'none';
}
// Close Button
let closeButton = document.createElement('div');
// Remove Top Bar
if (new RegExp(removeTopBar.join("|")).test(url)) {
var topBar = document.querySelectorAll("#O365ShellHeader");
topBar[0].style.display = "none";
}
// Close Button
let closeButton = document.createElement("div");

closeButton.className = 'ms-Button';
closeButton.style.position = 'absolute';
closeButton.style.right = '0px';
closeButton.style.top = '0px';
closeButton.style.lineHeight = '35px';
closeButton.style.width = '35px';
closeButton.style.height = '35px';
closeButton.style.background = 'rgba(0,0,0,0.3)';
closeButton.style.textAlign = 'center';
closeButton.style.color = 'white';
closeButton.style.cursor = 'pointer';
closeButton.style.fontSize = '20px';
closeButton.append('✖');
closeButton.addEventListener('click', () => {
window.close();
});
document.body.append(closeButton);
}, 3000);
closeButton.className = "ms-Button";
closeButton.style.position = "absolute";
closeButton.style.right = "0px";
closeButton.style.top = "0px";
closeButton.style.lineHeight = "35px";
closeButton.style.width = "35px";
closeButton.style.height = "35px";
closeButton.style.background = "rgba(0,0,0,0.3)";
closeButton.style.textAlign = "center";
closeButton.style.color = "white";
closeButton.style.cursor = "pointer";
closeButton.style.fontSize = "20px";
closeButton.append("✖");
closeButton.addEventListener("click", () => {
window.close();
});
document.body.append(closeButton);
}, 3000);
8 changes: 4 additions & 4 deletions public/main.css
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
/* hide the vertical ad bar */
._1_ag99JsBHxI6S4FP5ayPv {
display: none !important;
display: none !important;
}

/* hide the small ad bar in other email page */
._2a6h2L3Tl12cnq2P7ZG9y_ {
display: none !important;
display: none !important;
}

/* hide the upgrade premium ad bar */
._1ZEdP0-JdMOVtjBb5ZcM6M {
display: none !important;
}
display: none !important;
}
8 changes: 4 additions & 4 deletions public/no-frame.css
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
/* make the header higher and dragable */
._1Kg3ffZABPxXxDqcmoxkBA {
padding-top: 30px !important;
-webkit-app-region: drag;
padding-top: 30px !important;
-webkit-app-region: drag;
}

/* make the clickable component in header not dragable */
.ms-FocusZone,
._3Nd2PGu67wifhuPZp2Sfj5 {
-webkit-app-region: no-drag;
}
-webkit-app-region: no-drag;
}
Loading

0 comments on commit c54fcdd

Please sign in to comment.