diff --git a/README.md b/README.md index cccc56a1..98c54da1 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,35 @@ Refer to https://github.com/HathorNetwork/rfcs/blob/master/projects/wallet-servi ### Local environment #### System dependencies +``` +Node: 22x +yarn: v4 (yarn-berry) +``` -You need nodejs installed on your enviroment, we suggest the latest Active LTS version (v18.x.x). +#### Install nix (preferred) -#### Clone the project and install dependencies +For a better developer experience we suggest nix usage for managing the enviroment. Visit this [link](https://nixos.org/download/#download-nix) to download it. -`git clone https://github.com/HathorNetwork/hathor-wallet-service-sync_daemon.git` +To enable the commands `nix develop` and `nix build` using flakes, add the following to your `/etc/nix/nix.conf` file: + +``` +# see https://nixos.org/manual/nix/stable/command-ref/conf-file +sandbox = true +experimental-features = nix-command flakes +``` -`npm install` +#### Clone the project and install dependencies +```sh +$ git clone https://github.com/HathorNetwork/hathor-wallet-service.git +``` +To initialize nix dev environment: +```sh +$ nix develop +``` +then, install the depencies: +```sh +yarn +``` #### Add env variables or an .env file to the repository: