Skip to content

README.md

Latest commit

 

History

History
58 lines (39 loc) · 1.45 KB

README.md

File metadata and controls

58 lines (39 loc) · 1.45 KB

PKVault - Technical

PKVault project is composed as so:

  • a backend in C# .NET10
  • a frontend in Typescript/React
  • a desktop app in C# Photino

The core is the web app (backend & frontend). Desktop app is just consuming the web app as a container using Photino for web rendering.

flowchart TD
    B[Backend]
    PF@{ shape: docs, label: "Pokemon files"}
    F[Frontend]

    DW["Windows Desktop"]
    DL["Linux Desktop"]

    WAB{Web-App build}

    subgraph Web-App
        subgraph Backend environnement
        B --> PF
        end
    F --> B
    end

    WAB --> Web-App
    DW --> WAB
    DL --> WAB
Loading

Check each package README for more technical documentation.

Quick start

You can target dev & build for desktop Windows app or web app.

Editor note: all code & its documentation were made with/for VS Code. Any other editor may still work, without warranty.

1 - General preparation

  • Clone this repository including submodules (pokeapi)
  • Run the setup part in PKVault.Backend
  • Same with setup part in frontend

2a - Web app (backend + frontend)

2b - Desktop app

  • From project root, run make prepare-desktop (needs tool make)
  • Run the setup & dev parts in PKVault.Desktop