Skip to content

Commit

Permalink
Readme update (#130)
Browse files Browse the repository at this point in the history
  • Loading branch information
AgeManning committed Feb 27, 2023
1 parent a066d7b commit cbc30e0
Showing 1 changed file with 82 additions and 20 deletions.
102 changes: 82 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,87 @@
# Siren
User interface for Lighthouse

This is an open-source User Interface for the Lighthouse Ethereum Beacon Node
and Validator Client.

[![Book Status]][Book Link] [![Chat Badge]][Chat Link]

[Chat Badge]: https://img.shields.io/badge/chat-discord-%237289da
[Chat Link]: https://discord.gg/jpqcHXPRVJ
[Book Status]:https://img.shields.io/badge/user--docs-unstable-informational
[Book Link]: https://lighthouse-book.sigmaprime.io/lighthouse-ui.html
[stable]: https://github.com/sigp/siren/tree/stable
[unstable]: https://github.com/sigp/siren/tree/unstable

## Documentation

The [Lighthouse Book](https://lighthouse-book.sigmaprime.io) contains information for users and
developers. Specifically the [Lighthouse UI](https://lighthouse-book.sigmaprime.io/lighthouse-ui.html) section of the book.

## Building From Source

### Requirements

Building from source requires `Node v16.16.0` and `yarn`.

### Building From Source

The electron app can be built from source by first cloning the repository and
entering the directory:

```
$ git clone https://github.com/sigp/siren.git
$ cd siren
```

Once cloned, the electron app can be built and ran via the Makefile by:

```
$ make
```

alternatively it can be built via:

```
$ yarn
```

Once completed successfully the electron app can be run via:

```
$ yarn dev
```

### Running In The Browser

#### Docker (Recommended)

Docker is the recommended way to run a webserver that hosts Siren and can be
connected to via a web browser. We recommend this method as it established a
production-grade web-server to host the application.

`docker` is required to be installed with the service running.

The docker image can be built and run via the Makefile by running:
```
$ make docker
```

Alternatively, to run with Docker, the image needs to be built. From the repository directory
run:
```
$ docker build -t siren .
```

Then to run the image:
```
$ docker run --rm -ti --name siren -p 80:80 siren
```

This will open port 80 and allow your browser to connect. You can choose
another local port by modifying the command. For example `-p 8000:80` will open
port 8000.

To view Siren, simply go to `http://localhost` in your web browser.

# Running a Local Testnet

Expand Down Expand Up @@ -59,22 +140,3 @@ subdirectories will create a new testnet when running these commands again.
## Logs and Errors

Logs and errors can be found in the `./local-testnet/testnet-data` directory.


# Running Local Electron App
You can run this app locally with react scripts and electronJs.

## Requirements
`Node v16.16.0` and `yarn`

## How to setup and run local

CD into root of the project and run to setup node modules
```bash
yarn
```

Then run local server and electron by running:
```bash
yarn dev
```

0 comments on commit cbc30e0

Please sign in to comment.