Skip to content

[Bug] README.md references non-existent electron-app-legacy/ directory and missing uv prerequisite #303

@ajithhraj

Description

@ajithhraj

Describe the bug
The README.md has two documentation issues that block new contributors from getting started:

  1. The "Getting Started" and "Project Structure" sections reference electron-app-legacy/ which does not exist in the repository. Running the listed commands immediately fails.

  2. 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:

  1. Clone the repository
  2. Follow the "Electron App (Legacy)" getting started instructions
  3. Run cd electron-app-legacy — fails with no such file or directory

Issue 2:

  1. Follow the "Backend" getting started instructions
  2. Run uv sync with only Python installed
  3. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions