Skip to content
This repository has been archived by the owner on Oct 26, 2022. It is now read-only.

Commit

Permalink
update readme with instructions to pull a prebuilt image
Browse files Browse the repository at this point in the history
  • Loading branch information
kclejeune authored Sep 4, 2021
1 parent 5b42407 commit 5d61b4f
Showing 1 changed file with 22 additions and 18 deletions.
40 changes: 22 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,27 @@ Currently implemented:
- overview page w/ live updating (refreshes every 5s)
- list of device information

## Running the app

### Docker

The easiest way to setup and run the app with minimal development knowledge is to use [Docker](https://www.docker.com/get-started).
Follow the installation instructions from the website, and then run:

```bash
docker pull kclejeune/tmobile-isp-client:latest && docker run -p 3000:3000 -it kclejeune/tmobile-isp-client:latest
```

You can view the app on `http://localhost:3000`. To run on a different port, set the `PORT` environment variable
and pass it to the container with the following command:

```bash
export PORT=43210
docker pull kclejeune/tmobile-isp-client:latest && docker run -e PORT -p $PORT:$PORT -it kclejeune/tmobile-isp-client:latest
```

substituting `PORT=43210` for the actual port of your choice.

## Developing

Clone the project, install dependencies with `npm install` (or `pnpm install` or `yarn`), and then start a development server with:
Expand All @@ -18,7 +39,7 @@ npm run dev -- --host
npm run dev -- --open
```

## Building
### Building

This app uses the node adapter to enable server side rendering and reverse proxying to avoid CORS issues. Build for production with:

Expand All @@ -30,23 +51,6 @@ npm run build
To run in production, run `node ./build`

## Docker

To run the containerized version of this app, build the docker
image with

```bash
docker build --pull -t tmobile:latest .
```

and run the container with

```bash
docker run --rm -p 3000:3000 -it tmobile:latest
```

You can access the app on `localhost:3000`.

## Screenshots

### Desktop
Expand Down

0 comments on commit 5d61b4f

Please sign in to comment.