Skip to content

fix: update API server paths in README to point to legacy directory #225

Description

@pratik-naik003

Problem

The README.md file contains instructions for starting the API servers under the Usage > Starting the API Server section. It currently instructs users to run:

python server/app.py
python server-https/app.py

However, the server/ and server-https/ directories have been moved inside the legacy/ folder. A new user following these instructions will encounter a FileNotFoundError as the files no longer exist at the root directory.

Proposed fix

Update the startup commands in the README to reflect the correct directory structure by prepending legacy/ to the paths:

# WebSocket API
python legacy/server/app.py

# HTTPS API
python legacy/server-https/app.py

Acceptance criteria

  • The WebSocket API startup command in the README points to legacy/server/app.py.
  • The HTTPS API startup command in the README points to legacy/server-https/app.py.
  • The documented instructions can be executed successfully from the project root without path errors.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions