-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
72 additions
and
36 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Prettier configuration | ||
arrowParens: avoid | ||
requirePragma: false | ||
insertPragma: false | ||
proseWrap: always | ||
trailingComma: "none" | ||
tabWidth: 4 | ||
semi: true | ||
useTabs: false | ||
singleQuote: false | ||
printWidth: 120 | ||
plugins: | ||
- prettier-plugin-svelte | ||
overrides: | ||
- files: "*.svelte" | ||
options: | ||
parser: svelte |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Alerts | ||
|
||
Start typing here... | ||
Alerts (based on UI Toasts) are a safety feature for instant notification of an issue that occurred. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# Configuration Interface | ||
|
||
Start typing here... | ||
## Alert Listener |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Conventions | ||
|
||
Conventions set important rules for the development process that _should_ bring some kind of benefit. Commit, issue | ||
or PR conventions where not present during DH08, but the one below are left for suggestion: | ||
|
||
- use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) for commit naming | ||
|
||
## Prettier formatting for TypeScript | ||
|
||
The project uses the [Praxidike prettier configuration](https://github.com/TeamPraxidike/.github/blob/main/.prettierrc.yaml) | ||
Of course, feel free to modify and completely change the Prettier configuration and make a better one. | ||
|
||
```yaml | ||
# Prettier configuration | ||
arrowParens: avoid | ||
requirePragma: false | ||
insertPragma: false | ||
proseWrap: always | ||
trailingComma: "none" | ||
tabWidth: 4 | ||
semi: true | ||
useTabs: false | ||
singleQuote: false | ||
printWidth: 120 | ||
plugins: | ||
- prettier-plugin-svelte | ||
overrides: | ||
- files: "*.svelte" | ||
options: | ||
parser: svelte | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
# Envrionment Variables | ||
# Environment Variables | ||
|
||
Start typing here... | ||
The Serpenta GUI makes use of several environment variables for its configuration. These define the behaviour of | ||
the application allowing for easier non-business logic related configuration. | ||
|
||
| Environment variable name | Values | Comment | | ||
|--------------------------------|----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| `GUI_CUSTOM_APP_BAR` | `TRUE`/`FALSE` | Determines whether the top bar of the app is the custom one provided by Serpenta. Off will default the bar to use the native bar of the desktop environment. | | ||
| `GUI_AGGREGATOR_COMMAND` | string | Determines the name of the function will be called by the Grand Data Distributor when aggregating the data which it will subsequently redistribute. | | ||
| `GUI_COMMS_ALERT_CHANNEL_NAME` | string | | | ||
| `GUI_COMMS_LOG_CHANNEL_NAME` | string | | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Tauri Event Channels | ||
|
||
Start typing here... |