Skip to content
This repository has been archived by the owner on Dec 2, 2024. It is now read-only.

Commit

Permalink
fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
silky committed Jan 13, 2022
1 parent 21b592b commit 6d65da0
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions plutus-playground-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ simulate Plutus Applications.

## Getting started

The Plutus Playground is written in [PureScript](https://www.purescript.org/) and uses npm and [spago](https://github.com/purescript/spago) for managing dependencies. It talks to the [plutus-playground-server](https://github.com/input-output-hk/plutus/tree/master/plutus-playground-server) which also needs to be up and running during development. The client build also depends on purescript files that are generated by the backend service using [purescript-bridge](https://github.com/eskimor/purescript-bridge).
The Plutus Playground is written in [PureScript](https://www.purescript.org/) and uses npm and [spago](https://github.com/purescript/spago) for managing dependencies. It talks to the [plutus-playground-server](https://github.com/input-output-hk/plutusa-apps/tree/master/plutus-playground-server) which also needs to be up and running during development. The client build also depends on purescript files that are generated by the backend service using [purescript-bridge](https://github.com/eskimor/purescript-bridge).

**Note**: _The workflow described here relies heavily on Nix. This means you should either be working inside a nix-shell environment or use tools such as [lorri](https://github.com/target/lorri) or [nix-direnv](https://github.com/nix-community/nix-direnv) or similar to provide a suitable environment._

Expand All @@ -14,7 +14,7 @@ $ plutus-playground-server
```

The `plutus-playground-server` script is provided by the global [shell.nix](../shell.nix) and starts the server (If the command
is not available make sure you are in a nix-shell session or that lorri is ready). For additional information on invoking the backend server please refer to its [README.md](https://github.com/input-output-hk/plutus/blob/master/plutus-playground-server/README.md).
is not available make sure you are in a nix-shell session or that lorri is ready). For additional information on invoking the backend server please refer to its [README.md](https://github.com/input-output-hk/plutus-apps/tree/main/plutus-playground-server).

### Starting the frontend server

Expand All @@ -31,7 +31,7 @@ The `start` script will:
- Compile the purescript code
- Start the webkpack server

Once the `start` script completes you can access the frontend via [http://localhost:8009](http://localhost:8009)
Once the `start` script completes you can access the frontend via [https://localhost:8009](https://localhost:8009)

> **Note**: You may need to adjust `webpack.config.js` to serve non-SSL content; set
> `module.exports.devServer.https` to `false`.
Expand All @@ -45,7 +45,7 @@ The following outlines some essentials for actually working on the plutus playgr
Apart from the `start` script introduced above there are a couple of scripts for the most frequent tasks during development. In order to run a webpack server in development mode with automatic reloading use **webpack:server**:

```
$ npm webpack:server
$ npm run build:webpack:dev
```

Please refer to [package.json](./package.json) for the full set of provided scripts.
Expand Down Expand Up @@ -112,10 +112,5 @@ You can run the following command (from the repository root) to build the client
backend server with Nix:

```sh
$ nix-build \
--option trusted-public-keys "hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ=" \
--option substituters https://hydra.iohk.io \
-A plutus-playground.client -A plutus-playground.server
$ nix-build -A plutus-playground.client -A plutus-playground.server
```

**Note**: When building the client make sure that the generated directory is removed completely or you will get _Duplicate module_ errors.

0 comments on commit 6d65da0

Please sign in to comment.