From 17a49a42ced2a22df2ced54ae10c0510e70cf854 Mon Sep 17 00:00:00 2001 From: Hernan Rajchert Date: Wed, 8 Nov 2023 19:42:49 +0400 Subject: [PATCH] Update client readme --- marlowe-playground-client/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/marlowe-playground-client/README.md b/marlowe-playground-client/README.md index 21a8b26d8..454c53a76 100644 --- a/marlowe-playground-client/README.md +++ b/marlowe-playground-client/README.md @@ -3,13 +3,15 @@ ## Getting started Make sure you have a local backend server running first: + ```bash -[nix-shell] $ marlowe-playground-server +[nix-shell] $ start-backend ``` Check the [backend documentation](../marlowe-playground-server/README.md) for more information on how to setup the Github OAuth application. Now we will build and run the front end: + ```bash [nix-shell] $ cd marlowe-playground-client # Generate the purescript bridge files @@ -26,8 +28,8 @@ Now we will build and run the front end: ## Adding dependencies -* Javascript dependencies are managed with npm, so add them to [package.json](./package.json) -* purescript uses package sets managed by spago so if the package set doesn't contain a dependency you can add it to [../packages.dhall](../packages.dhall) +- Javascript dependencies are managed with npm, so add them to [package.json](./package.json) +- purescript uses package sets managed by spago so if the package set doesn't contain a dependency you can add it to [../packages.dhall](../packages.dhall) Whenever you change `packages.dhall` you need to make sure that all dependencies can still properly be resolved and built. You can do so using the `update-client-deps` script: @@ -37,7 +39,6 @@ You can do so using the `update-client-deps` script: The `update-client-deps` script will generate/update `.nix` files which have to be committed and are required for a successful CI run. - ## Code formatting The code is formatted using [purs-tidy](https://github.com/natefaubion/purescript-tidy), and there is a CI task that will fail if the code is not properly formatted. You can apply purs-tidy to the project by calling: