5
Home
stan44 edited this page 2026-02-23 20:19:14 -06:00

Project Journal Wiki

Welcome to the Project Journal documentation hub.

Project Journal is an offline-first journaling system with encrypted monthly vaults, desktop + CLI workflows, and optional local AI support.

Wiki Pages

Use these pages as your Gitea wiki starter set:

  • Home (this page)
  • Setup and Installation (WIKI_SETUP.md)
  • CLI Reference (WIKI_CLI.md)
  • Vaults and Data Handling (WIKI_VAULTS.md)
  • Migration Acceptance Criteria (WIKI_MIGRATION_ACCEPTANCE_CRITERIA.md)
  • API and Sidecar Contract (WIKI_API_CONTRACT.md)
  • Cutover Runbook (Phase 6) (WIKI_CUTOVER_RUNBOOK.md)
  • Troubleshooting (WIKI_TROUBLESHOOTING.md)
  • Development Workflow (WIKI_DEVELOPMENT_WORKFLOW.md)

Quick Start (Python Baseline)

Windows (CPU default)

cd Project_Journal
py -3.14 -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install --extra-index-url https://download.pytorch.org/whl/cpu -r requirements_cpu_only.txt
python .\journal\run_desktop.py

Linux (CPU default)

cd Project_Journal
python3.14 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install --extra-index-url https://download.pytorch.org/whl/cpu -r requirements_cpu_only.txt
python ./journal/run_desktop.py

Current Direction

  • Python backend remains the active baseline.
  • C# backend migration is in progress in journal-master/journal/.
  • Security posture target is HIPAA-capable architecture and safeguards (not a legal compliance certification claim).

Core References

  • Project readme: README.md
  • Python CLI: journal/cli/main.py
  • Python storage and vault logic: journal/core/storage.py
  • C# backend readme: journal-master/journal/README.md
  • C# minimal machine setup: journal-master/journal/MINIMAL_MACHINE_SETUP.md

Safety Notice

Project Journal is a software tool and not a replacement for licensed mental health care, emergency services, or crisis intervention.