Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated quickstart.md to contemplate common issue #861

Merged
merged 1 commit into from
Dec 5, 2024

Conversation

fede2442
Copy link
Contributor

@fede2442 fede2442 commented Dec 5, 2024

Issue Found

Relates to:

N/A

Risks

Low, only may affect some users while setting up the initial environment.

Background

While trying to run the project I encountered an issue. There was no specification on the pnpm version and even though I had all the other versions correctly, I was getting the same constant error.

The project requires specific versions of pnpm (9+?) as defined in the package.json, but when trying to install dependencies, I kept getting ERR_PNPM_META_FETCH_FAIL errors and broken lockfile warnings.

The root cause was a mismatch between my system's pnpm version and the one specified in the project.

What does this PR do?

This is a simple change in the documentation to add the specific versions needed for pnpm, npm, etc. And also a better git checkout to get the latest version of the repo.

Documentation changes needed?

This is a documentation change

Testing

image

Detailed testing steps

Set the pnpm version to anything below v9 and try to run

pnpm install

Solution

Using nvm + corepack solved the issue. After fixing this on my end, I'm adding this documentation to improve experience!

   corepack enable
   corepack prepare [email protected] --activate

Issue Found

While trying to run the project I encountered an issue. There was no specification on the pnpm version and even though I had all the other versions correctly, I was getting the same constant error. 

The project requires specific versions of pnpm (9+?) as defined in the package.json, but when trying to install dependencies, I kept getting ERR_PNPM_META_FETCH_FAIL errors and broken lockfile warnings.

The root cause was a mismatch between my system's pnpm version and the one specified in the project.

Solution

Using nvm + corepack solved the issue. After fixing this on my end, I'm adding this documentation to improve experience!

'''
   corepack enable
   corepack prepare [email protected] --activate
'''

Helped me solve the issue.
Copy link
Collaborator

@monilpat monilpat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@jkbrooks jkbrooks merged commit 09c7b03 into elizaOS:main Dec 5, 2024
2 of 3 checks passed
@fabianhug
Copy link
Member

good job @fede2442

@oxSaturn oxSaturn mentioned this pull request Dec 6, 2024
dsldsl pushed a commit to dsldsl/eliza that referenced this pull request Dec 7, 2024
Updated quickstart.md to contemplate common issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants