Update README.md file

[soumya-78]

Added detailed instructions to the README.md file to help new contributors set up their local environment for development. Also included links to relevant documentation and resources.

[nicolasburtey]

Suggested change

	3. Run cargo run command to run all tests of the Galoy CLI repository and see the usage, commands, and options available to interact.
	3. Run `cargo run` command to run all tests of the Galoy CLI repository and see the usage, commands, and options available to interact.

command should be within ` "brackets"

[nicolasburtey]

this is not very clear.

[nicolasburtey]

ideally we would want to highlight that the backend can also be run locally by running https://github.com/GaloyMoney/galoy (so you don't have to fetch our staging environment). the captcha can also be deactivated with the local dev environment

[soumya-78]

So i need to remove this?

[soumya-78]

@nicolasburtey i think i should update the readme with providing the link to galoy backend(https://github.com/GaloyMoney/galoy) in place of these commands.

[thevaibhav-dixit]

I think jwt is not a valid term for the access token we get when we login ? I even got error when I tired to set in access token as JWT in the cli. @nicolasburtey

[soumya-78]

I am also getting error. basically showing "jwt syntax issue".

[nicolasburtey]

yup long story short, there should no longer be a JWT stored, but a kratos token. it should also be passed as a Authorization header to the backend.

[nicolasburtey]

it probably means this command line should be update. maybe there is no code change necessary because functionally if we assumed the JWT was an opaque token (ie: we were not trying to decode it), then it should be functionally the same with the kratos token

[thevaibhav-dixit]

imho to make this functional we need to remove this https://github.com/GaloyMoney/galoy-cli/blob/main/src/main.rs#L84-L86 . Here we are trying to check for a valid JWT. I tried to this way and it worked for me. Maybe we can replace this with a simple check if the token adheres to a fix length ?

[nicolasburtey]

yup this should not longer work with the new way we authenticate query. this should be removed.

[soumya-78]

@nicolasburtey if we remove the part mentioned by @thevaibhav-dixit then how to authenticate, like based on the length of JWT?

[soumya-78]

And the error in checks coming due to old version of remove_dir_all that is 0.5.3 as it is supported with version above 0.8.0. but there is no crate "remove_dir_all" in cargo.toml that need to be updated. how to solve this issue can you please guide me?

[r0ushann]

1. Clone the /galoy-cli repository using git clone https://github.com/GaloyMoney/galoy-cli.git

[r0ushann]

Galoy-cli

Galoy CLI is a Rust-based CLI client that can interact with the Galoy backend using GraphQL queries and mutations.

Rust Installation and cargo commands

go through the installation guide at https://www.rust-lang.org/learn/get-started

galoy-cli Installation

for getting started with the installation and running galoy-cli locally , set up a local environment first.

1. Clone galoy-cli repository using git clone https://github.com/GaloyMoney/galoy-cli.git
2. Install Rust in your local machine and run cargo build to build all binary and library targets of the selected packages.
3. Run cargo run command to run your project and cargo test to run all the tests of the Galoy CLI repository and see the usage, commands, and options available to interact.
4. Interact with the CLI yourself to become familiar with it.

The Galoy backend can also be run locally by cloning the repository from https://github.com/GaloyMoney/galoy. Running the backend locally allows you to test and develop features without needing to fetch data from our staging environment. Additionally, the CAPTCHA feature can be deactivated in the local development environment.