Skip to content

Home

This is hosted in GitHub Pages. Happy Reading.

Installation

1. Install mkdocs via pip

pip install mkdocs

2. Install all the necessary packages

pip install mkdocs-material
pip install "mkdocstrings[python]"
pip install mkdocs-awesome-pages-plugin 
pip install mkdocs-autorefs

3. Run the server locally

mkdocs serve

How To Deploy

Only manual deployment is supported. GitHub Pages for private repositories is not available for free tier.

1. Add Remote [Only Once]

git remote add docs https://github.com/Solenergy-Systems-Inc/envision-evdriver-backend-docs.git

2. Deploy

mkdocs gh-deploy -r docs

BE System Overview

---
config:
     flowchart:
        subGraphTitleMargin:
            top: 10
---
flowchart LR

    fe_manager["EVCS Manager"] --- std["Standard"]
    fe_manager["EVCS Manager"] --- be_aws["BE (Serverless on AWS)"]

    fe_driver["EVCS Driver Web (Next.js) \n&\n EVCS Driver Mobile (Flutter)"] --- be_aws["BE (Serverless on AWS)"]
    fe_driver ---|CONTROL| be_ws["BE (FastAPI on VPS)"]

    subgraph be["EV BE"]
        be_aws --- misc["PayMongo, AWS SQS, ITEXMO, etc."]
        be_aws --- db
        be_de["BE (Dagster)"] --- db[AWS RDS]
        be_ws --- db
    end

    be_ws --- em[Embedded]

    em --- Charger