https://github.com/hochfrequenz/entscheidungsbaumdiagramm
🌳 EBDs REFURBISHED
https://github.com/hochfrequenz/entscheidungsbaumdiagramm
bdew entscheidungsbaumdiagramm marktkommunikation sveltekit
Last synced: 6 months ago
JSON representation
🌳 EBDs REFURBISHED
- Host: GitHub
- URL: https://github.com/hochfrequenz/entscheidungsbaumdiagramm
- Owner: Hochfrequenz
- License: gpl-3.0
- Created: 2024-10-01T18:48:16.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-12-09T02:59:20.000Z (6 months ago)
- Last Synced: 2024-12-09T03:31:12.947Z (6 months ago)
- Topics: bdew, entscheidungsbaumdiagramm, marktkommunikation, sveltekit
- Language: Svelte
- Homepage: https://ebd.stage.hochfrequenz.de
- Size: 685 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EBD.HOCHFREQUENZ.DE
### ⚙️ Setting up development environment
Make sure you have the latest version of [node](https://nodejs.org/en) installed (recommended via node version manager [nvm](https://github.com/nvm-sh/nvm)).
```sh
$ npm install
```
```sh
$ npm run start # starts local dev server (including hot reload)
$ npm run lint # lints the whole project (eslint)
$ npm run format # formats the whole project (prettier)
$ npm run test # runs E2E tests (playwright) assuming the dev server is up and running
```
To serve the built site locally, run
```sh
$ npm run serve
```
```sh
$ npm run build && npx http-server ./build
```
This starts an HTTP server at http://127.0.0.1:8080, providing a local view roughly equivalent to how Azure will render the project.
### 🏷️ Semantic commit messages
To meet the pull request title convention [requirements](https://github.com/Hochfrequenz/entscheidungsbaumdiagramm/blob/main/.github/workflows/conventional-commit-validation.yml) enforced by Github Actions, here is a brief guide to help choosing the appropriate tag for each purpose:
- `build:` - changes that affect the build system or external dependencies
- `chore:` - miscellaneous commits and routine tasks
- `ci:` - changes to the CI/CD configuration
- `docs:` - updating the documentation
- `feat:` - adding or removing a feature feature
- `fix:` - bug fixes
- `perf:` - performance improvement
- `refactor:` - improve code structure, readability, or maintainability
- `revert:` - reverts a previous commit
- `style:` - code formatting and styling that do not affect functionality
- `test:` - adding or updating tests
### 🏛 Architecture
```mermaid
flowchart TD
A("edi-energy-mirror:
raw documents (PDF, docx)") -->|ebdamame 🫛
& rebdhuhn 🐥| B("machine-readable-
entscheidungsbaumdiagramme")
B -->|synced submodule 🔄| C("entscheidungsbaumdiagramm frontend 🌳")
C -->|Github Actions
trigger: PR created/updated| D("deployment preview")
C -->|Github Actions
trigger: PR merged
into main| E("ebd.stage.hochfrequenz.de")
C -->|Github Actions
trigger: release| F("ebd.hochfrequenz.de")
```
### 🔐 Auth0 authentication
> [!NOTE]
> During local development, authentication is currently not required. Instead, a dummy account `[email protected]` will be already logged in at both local dev server startup as well as build preview.
To get past the landing page when navigating through the staging environment `https://ebd.stage.hochfrequenz.de` and production environment `https://ebd.hochfrequenz.de`, users need to authenticate using their Hochfrequenz login credentials.
### 🔗 Links
[Marktgut](https://hochfrequenz-marktplatz.atlassian.net/browse/HFMP-67)
[Azure](https://portal.azure.com/#@hochfrequenz.net/resource/subscriptions/1cdc65f0-62d2-4770-be11-9ec1da950c81/resourceGroups/entscheidungsbaumdiagramm/providers/Microsoft.Web/staticSites/entscheidungsbaumdiagramm-frontend-stage/staticsite)
[ebdamame](https://github.com/Hochfrequenz/ebdamame)
[rebdhuhn](https://github.com/Hochfrequenz/rebdhuhn)
[EBD toolchain](https://github.com/Hochfrequenz/ebd_toolchain)
[machine-readable EBDs](https://github.com/Hochfrequenz/machine-readable_entscheidungsbaumdiagramme/)
[BDEW](https://www.edi-energy.de/index.php?id=38&tx_bdew_bdew%5Bview%5D=future&tx_bdew_bdew%5Baction%5D=list&tx_bdew_bdew%5Bcontroller%5D=Dokument&cHash=325de212fe24061e83e018a2223e6185)