Confusing Readme

[christopheragnus]

Describe the bug
I am trying to setup the Echo repo locally but the Readme looks outdated. The links under this section should be pointing to .cursor/rules. However, it is currently relative to current & incorrect directory.

To Reproduce
Steps to reproduce the behavior:

1. Go to this page: https://github.com/Dembrane/echo/tree/main/echo#map-of-documents

Expected behavior
docs/database_commands.md give 404 errors because they are missing.
None of the links point to correct docs files under the correct directory.

[linear[bot]]

ECHO-93 Confusing Readme

[spashii]

Hey there 👋🏻. Thanks for catching this one. I moved the docs to the .cursor/rules folder at some point and forgot to update the README

[ussaama]

@christopheragnus Thank you for catching this. The issue has been fixed. Please let us know if you have any other suggestions.

[ussaama]

#56

[christopheragnus]

@christopheragnus Thank you for catching this. The issue has been fixed. Please let us know if you have any other suggestions.

I'm also getting an error after following the readme and setting up the Docker container.

Steps to reproduce:

1. Cloned Echo Repo in WSL2
2. Setup according to the server readme: https://github.com/Dembrane/echo/blob/main/echo/readme.md
3. Opened echo in VS Code & then executed Open Folder in Container.
4. Checked all containers are running in Docker
5. Ran npm run dev in echo/frontend folder
6. Login using admin@dembrane.com / admin
7. When clicking on Create Project, I get the following error:

Proxying request to /api/projects
3:13:40 PM [vite] http proxy error: /api/projects
Error: connect ECONNREFUSED [127.0.0.1:8000](http://127.0.0.1:8000/)
    at TCPConnectWrap.afterConnect [as oncomplete] (node:net:1607:16)

Any assistance on this?

[ussaama]

@christopheragnus
You can follow these steps to resolve the issue:

1- Login to directus
2- Go to Settings > Data Model and delete "Aspect and Quote" collection

3- Then go to "echo/directus" folder and run the following command: "npx directus-sync -u http://directus:8055 -e admin@dembrane.com -p admin push -d -f"

4- rerun the project again and everything should work fine

[christopheragnus]

I'm still getting the same error after running the above.

Steps I took:

1. Deleted the Aspect and Quote collection
2. Got an error about the Node version so switched to Node v 22.14.0
3. Ran npx directus-sync -u http://localhost:8055 -e admin@dembrane.com -p admin push -d -f successfully
4. Restarted Docker container
5. Ran npm run dev in echo/frontend
6. Create project still gives the same error

[ussaama]

1. Could you try rebuilding the project inside the container? You can do this by pressing Ctrl + Shift + P and selecting "Rebuild in Container".

2. Please attach the full error log so we can better understand the issue.

[christopheragnus]

1. Could you try rebuilding the project inside the container? You can do this by pressing Ctrl + Shift + P and selecting "Rebuild in Container".
2. Please attach the full error log so we can better understand the issue.

This was in the Dev Containers terminal in VS Code after I ran Dev Containers: Rebuild Container Without Cache.

docker-logs.txt

I don't see any other errors aside from this one in the terminal:

Error: there is no registered task type 'func'. Did you miss installing an extension that provides a corresponding task provider?

I suspect its referring to tasks.json? I think something to do with this section?

   {
      "type": "func",
      "label": "func: host start",
      "command": "host start",
      "problemMatcher": "$func-python-watch",
      "isBackground": true,
      "dependsOn": "pip install (functions)",
      "options": {
        "cwd": "${workspaceFolder}/azure-functions"
      }
    },

[christopheragnus]

This is the logs of setup.sh:

➜  echo git:(main) ✗ ./setup.sh
Checking dependencies for the installation script...
Checking availability of curl... OK!
Checking availability of unzip... OK!
Downloading https://github.com/Schniz/fnm/releases/latest/download/fnm-arm64.zip...
This script will automatically download and install rye (latest) for you.
warning: this script is running as root.  This is dangerous and unnecessary!
##########                  # # # # # # # # # # # #                                        8.7%########################################################################### 100.0%
######################################################################## 100.0%
Installing for Zsh. Appending the following to /home/christopherlam/.zshrc:

# fnm
FNM_PATH="/home/christopherlam/.local/share/fnm"
if [ -d "$FNM_PATH" ]; then
  export PATH="/home/christopherlam/.local/share/fnm:$PATH"
  eval "`fnm env`"
fi

In order to apply the changes, open a new terminal or run the following command:

  source /home/christopherlam/.zshrc
Welcome to Rye!

This installer will install rye to /home/christopherlam/.rye
This path can be changed by exporting the RYE_HOME environment variable.

Details:
  Rye Version: 0.44.0
  Platform: linux (aarch64)

Installing Node v18.20.7 (arm64)
warning: Version already installed at "/home/christopherlam/.local/share/fnm/node-versions/v18.20.7"
Installed binary to /home/christopherlam/.rye/shims/rye
Updated self-python installation at /home/christopherlam/.rye/self

The rye directory /home/christopherlam/.rye/shims was not detected on PATH.
It is highly recommended that you add it.
Added to PATH.
note: for this to take effect you will need to restart your shell or run this manually:

    source "$HOME/.rye/env"

To make it work with zsh, you might need to add this to your .zprofile:

    source "$HOME/.rye/env"

For more information read https://rye.astral.sh/guide/installation/

All done!
Reusing already existing virtualenv
Generating production lockfile: /home/christopherlam/echo/echo/server/requirements.lock
⠙Generating dev lockfile: /home/christopherlam/echo/echo/server/requirements-dev.lock
⠼Installing dependencies
Resolved 125 packages in 62ms
⠴Audited 125 packages in 102ms
⠦Done!

changed 1 package in 11s

1 package is looking for funding
  run `npm fund` for details
error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
    python3-xyz, where xyz is the package you are trying to
    install.

    If you wish to install a non-Debian-packaged Python package,
    create a virtual environment using python3 -m venv path/to/venv.
    Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
    sure you have python3-full installed.

    If you wish to install a non-Debian packaged Python application,
    it may be easiest to use pipx install xyz, which will manage a
    virtual environment for you. Make sure you have pipx installed.

    See /usr/share/doc/python3.12/README.venv for more information.

note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.
 ERR_PNPM_NO_GLOBAL_BIN_DIR  Unable to find the global bin directory

Run "pnpm setup" to create it automatically, or set the global-bin-dir setting, or the PNPM_HOME env variable. The global bin directory should be in the PATH.
Lockfile is up to date, resolution step is skipped
Already up to date

╭ Warning ───────────────────────────────────────────────────────────────────────────────────╮
│                                                                                            │
│   Ignored build scripts: @swc/core, canvas, es5-ext, esbuild.                              │
│   Run "pnpm approve-builds" to pick which dependencies should be allowed to run scripts.   │
│                                                                                            │
╰────────────────────────────────────────────────────────────────────────────────────────────╯

Done in 1.9s using pnpm v10.6.2
Setup complete

[ussaama]

You can install an extension called "Restore Terminals" and press ctrl+shift+p and search for "Restore Terminals" in your code editor and click on it. That would re run the project.

A video demonstration of the whole process is going to be uploaded soon. The video will address these issues in detail.

[christopheragnus]

You can install an extension called "Restore Terminals" and press ctrl+shift+p and search for "Restore Terminals" in your code editor and click on it. That would re run the project.

A video demonstration of the whole process is going to be uploaded soon. The video will address these issues in detail.

ok, i got it working finally! It looks like the Docker container didn't install Node and pnpm (according to the terminal) after I ran Restore Terminals. I manually installed both using curl in the VS Code Terminal and ran Restore Terminals again and it finally showed the Ports tab.

This worked for commit 7015818a0320a856a6415b36ea9e9890eec045a5. I tried with the latest code commit and it looks like something is broken there.

[ussaama]

@christopheragnus i forgot to mention that with the new commits in "Echo", it has been updated to use s3 bucket for storage. That is causing you the error

Proxying request to /api/projects
8:30:49 AM [vite] http proxy error: /api/projects
Error: connect ECONNREFUSED 127.0.0.1:8000
    at TCPConnectWrap.afterConnect [as oncomplete] (node:net:1634:16)

Please add the following environment variables in the env file of "echo > echo > server" directory and the issue would be resolved:

STORAGE_S3_REGION=<region>
STORAGE_S3_ENDPOINT=<storage-endpoint>
STORAGE_S3_BUCKET=<name>
STORAGE_S3_KEY=<key>
STORAGE_S3_SECRET=<secret>

[christopheragnus]

@ussaama is there a way to populate the app with dummy data as well, other than creating a conversation manually?

[ussaama]

At the moment, the only way to generate conversations is by creating them manually.

[spashii]

I propose the following changes to close this discussion.

• Have a clear documentation section in the main README.md as a point of entry
• Separate the "User Guide" and "Developer Docs"
• General cleanup of the docs, include details about any relevant configuration needed to develop

I've self-assigned and will open a PR soon.