Skip to content

Commit

Permalink
Update client readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hrajchert committed Nov 8, 2023
1 parent 0e770c4 commit 17a49a4
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions marlowe-playground-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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:
Expand Down

0 comments on commit 17a49a4

Please sign in to comment.