Describe the bug
The README.md has two documentation issues that block new contributors from getting started:
-
The "Getting Started" and "Project Structure" sections reference electron-app-legacy/ which does not exist in the repository. Running the listed commands immediately fails.
-
The "Prerequisites" section lists Node.js, Python 3.12+, and PostgreSQL — but the first backend setup command is uv sync, which requires Astral's uv package manager. It is not listed as a prerequisite.
To Reproduce
Issue 1:
- Clone the repository
- Follow the "Electron App (Legacy)" getting started instructions
- Run
cd electron-app-legacy — fails with no such file or directory
Issue 2:
- Follow the "Backend" getting started instructions
- Run
uv sync with only Python installed
- Fails with
command not found: uv
Expected behavior
- README.md should either remove the
electron-app-legacy/ references or restore the directory if it was accidentally deleted
uv should be listed under Prerequisites with installation instructions (e.g. pip install uv)
Screenshots
N/A
Environment
- OS: Any
- Node.js version: >= 18
- Python version: 3.12+
Additional context
The electron-app-legacy/ folder appears to have been removed during a recent project restructuring commit but the README was not updated accordingly.
Describe the bug
The README.md has two documentation issues that block new contributors from getting started:
The "Getting Started" and "Project Structure" sections reference
electron-app-legacy/which does not exist in the repository. Running the listed commands immediately fails.The "Prerequisites" section lists Node.js, Python 3.12+, and PostgreSQL — but the first backend setup command is
uv sync, which requires Astral'suvpackage manager. It is not listed as a prerequisite.To Reproduce
Issue 1:
cd electron-app-legacy— fails withno such file or directoryIssue 2:
uv syncwith only Python installedcommand not found: uvExpected behavior
electron-app-legacy/references or restore the directory if it was accidentally deleteduvshould be listed under Prerequisites with installation instructions (e.g.pip install uv)Screenshots
N/A
Environment
Additional context
The
electron-app-legacy/folder appears to have been removed during a recent project restructuring commit but the README was not updated accordingly.