https://github.com/floogulinc/hydrus-web

Web client for Hydrus
https://github.com/floogulinc/hydrus-web

angular angular-material hydrus hydrusnetwork

Last synced: 7 days ago
JSON representation

Web client for Hydrus

• Host: GitHub
• URL: https://github.com/floogulinc/hydrus-web
• Owner: floogulinc
• License: mit
• Created: 2019-05-26T06:53:01.000Z (over 5 years ago)
• Default Branch: dev
• Last Pushed: 2024-05-28T02:33:22.000Z (6 months ago)
• Last Synced: 2024-05-28T12:13:36.748Z (6 months ago)
• Topics: angular, angular-material, hydrus, hydrusnetwork
• Language: TypeScript
• Homepage: https://hydrus.app
• Size: 6 MB
• Stars: 89
• Watchers: 5
• Forks: 8
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        




 Hydrus Web 


Hydrus web is a web client for [Hydrus](https://hydrusnetwork.github.io/hydrus/)














## Usage

### hydrus.app

[hydrus.app](https://hydrus.app/) is the recommended way to use Hydrus Web. It will always be the latest stable version (latest commit on the `master` branch) of Hydrus Web. It is automatically deployed with [Vercel](https://vercel.com/).

The latest development build (latest commit on the `dev` branch) can be found at [dev.hydrus.app](https://dev.hydrus.app/).

### Docker

A [Docker image](https://github.com/floogulinc/hydrus-web/pkgs/container/hydrus-web) is provided for Hydrus Web. 

It hosts Hydrus Web on port 80 using nginx. Hydrus Web needs to be hosted with valid HTTPS unless it is only being used on `localhost`. The Docker image is meant to be used with some proxy that can provide HTTPS (like Caddy or Traefik).

You may also want to run [Hydrus on Docker](https://hydrusnetwork.github.io/hydrus/docker.html).

## Hydrus API HTTPS

Unless you are opening Hydrus Web on the same device the Hydrus client is running on, you will need to make its API available with valid HTTPS. This will likely mean running some form of reverse proxy.

There are some guides on doing this on the [wiki](https://github.com/floogulinc/hydrus-web/wiki).

## Hydrus Version Support

The minimum required versions of the Hydrus client for Hydrus Web are:

| Hydrus Web | Hydrus Client Version |

|--|--|

| Stable branch ([hydrus.app](https://hydrus.app/)) | v500 |

| Dev branch ([dev.hydrus.app](https://dev.hydrus.app/)) | v500 |

| 1.0.0+ | v500 |

| [0.3.2](https://github.com/floogulinc/hydrus-web/releases/tag/v0.3.2) | v357 probably |

Some features may require a newer Hydrus version than the minimum.

## Development

### Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

### Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

### Build

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.

### Running unit tests

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).

### Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).

### Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).