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

docs: update short guide of dev setup #3285

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

docs: update short guide of dev setup #3285

wants to merge 15 commits into from

Conversation

brunoffranca
Copy link
Member

@brunoffranca brunoffranca commented Nov 14, 2024

What ❔

Updates the setup dev guide and turns it into a fully automated script. You just need to run one curl command and everything will be installed with no user input. Also fixed some minor issues with the previous guide:

  • Removed the HTTPS configuration for git. Instead uses HTTPS by default since that's Github recommendation.
  • Installs git along with the other necessary packages.
  • Adds --locked flag to cargo-nextest installation since that's the recommended way.
  • Changed installation steps order to make more sense (ex: we were installing curl after using it).
  • Included ZK Stack CLI in the installation instead of having it separate.

@brunoffranca brunoffranca marked this pull request as draft November 15, 2024 02:10
@brunoffranca
Copy link
Member Author

brunoffranca commented Nov 15, 2024

On the Foundry-zksync install script, we probably need to add . "$SHELL_CONFIG_FILE" after echo "Installation completed successfully!" since the verification afterwards fails (running source ~/.bashrc solved it on my machine).

Update: Replacing if forge --version | grep -q "0.0.2" with if "$HOME/.foundry/bin/forge" --version | grep -q "0.0.2" should do the trick.

Update: I'm waiting for write permissions to add this fix. It doesn't impact this PR though.

@brunoffranca brunoffranca marked this pull request as ready for review November 15, 2024 17:18
@brunoffranca
Copy link
Member Author

Weird. When running zkstack dev fmt or zkstack dev lint after this installation, it complains that Prettier is not installed. But I can check that it is.

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.

1 participant