Request for a Simple Guide on ESM and Required Dependencies

[lincheoll]

Hi,

While trying to integrate elizaos/core into my project, I encountered the following issues:

1. ESM-related Problems

   • During testing with both JavaScript and TypeScript, I faced challenges due to ESM compatibility.
   • For instance, the need to set "type": "module" in package.json wasn't clearly mentioned, which caused some confusion.

2. Required Dependencies

   • Packages like sharp, dotenv, and @tavily/core had to be installed separately to make the project work.
   • These dependencies were not mentioned in the documentation, leading to initial setup difficulties.

To address these issues, it would be helpful to have a simple guide covering the following points:

• Basic Configuration
  • What needs to be added to package.json (e.g., "type": "module")
• Recommended TypeScript Settings
  • Suggested tsconfig.json configuration
• Required Dependencies
  • A list of dependencies necessary for the project to run

A beginner-friendly guide with clear instructions for the initial setup would be greatly appreciated.

Thank you!

[JoeyKhd]

Is this with the eliza starter?

Also the issue you faced is properly described in the readme:

Additional Requirements
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:

pnpm install --include=optional sharp

[lincheoll]

@JoeyKhd

Issues arise when attempting to integrate it with an existing project using:

npm install @elizaos/core

Additionally, it's problematic that not only sharp but also other packages are required to be installed separately.