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

The "Running Locally" section of the fuels-wallet documentation needs re-working #1261

Open
HoTandy opened this issue Apr 30, 2024 · 0 comments
Labels
bug Something isn't working p2

Comments

@HoTandy
Copy link
Contributor

HoTandy commented Apr 30, 2024

After some conversation with @helciofranco, it would be a good idea to re-work the Running Locally section of the fuels-wallet documentation https://wallet.fuel.network/docs/contributing/running-locally/

The current documentation is not quite specific enough when a new dev is trying to get the project up and running locally, the instructions can be a bit arbitrary, not synchronised well enough and not specific enough.

To get a local version of the wallet running and to be able to run the E2E tests, the user needs to step through the following instructions:

  • pnpm install

  • pnpm exec playwright install --with-deps chromium

  • cp packages/app/.env.example packages/app/.env (to setup our network)

  • pnpm node:up (to start a local fuel node)

  • pnpm dev:crx (to start the extension locally)

  • At this point the prompt will not return but the user will see the following screen:

Image

  • in a new terminal window, run pnpm test:e2e - at this point, all the tests should pass

If other examples of commands are shown in the documentation, then be specific about what the command does.

For other .env example files, like, .env.tests and .env.production, let the user know what these examples are for and when they should be used.

@HoTandy HoTandy added the bug Something isn't working label Apr 30, 2024
@LuizAsFight LuizAsFight added the p2 label May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working p2
Projects
None yet
Development

No branches or pull requests

2 participants