https://github.com/macav/hotelier

Tray App for Hotel Process Manager
https://github.com/macav/hotelier

devtools electron hotel javascript process-manager react server-management

Last synced: 5 months ago
JSON representation

Tray App for Hotel Process Manager

• Host: GitHub
• URL: https://github.com/macav/hotelier
• Owner: macav
• License: mit
• Created: 2018-05-06T09:37:16.000Z (about 8 years ago)
• Default Branch: develop
• Last Pushed: 2023-02-03T04:53:57.000Z (over 3 years ago)
• Last Synced: 2024-06-21T06:40:42.363Z (almost 2 years ago)
• Topics: devtools, electron, hotel, javascript, process-manager, react, server-management
• Language: TypeScript
• Size: 2.04 MB
• Stars: 52
• Watchers: 2
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Hotelier

Tray App for [Hotel](https://github.com/typicode/hotel) process manager which works on Windows, Mac and (potentially) Linux.

## Install

Download the [latest release](https://www.github.com/macav/hotelier/releases) and install it.

Alternately, install with [Homebrew](https://brew.sh) on macOS:

```shellsession

$ brew tap macav/hotelier https://www.github.com/macav/hotelier.git

$ brew install --cask hotelier

```

## About

![windows_screenshot](public/assets/hotelier_windows.png)

![mac_light_screenshot](public/assets/hotelier_mac_light.png)

![mac_dark_screenshot](public/assets/hotelier_mac_dark.png)

![mac_dark_logs](public/assets/hotelier_logs.png)

### Description

The main purpose of the app is allowing easy management of the servers directly from the tray / menu bar, without the need of opening the `Hotel` in the browser, or using the CLI.

The app works currently in a happy path scenario, meaning for example it doesn't handle situation where you don't have `Hotel` installed.

It is created using React & Electron, making it easy to extend. The downside is the app size (~ 150 MB), but that's the price to pay for the maintainability.

### Motivation

I decided to create the app because all other alternatives didn't work properly for me, or where too outdated and not maintained anymore (2018).

### Builds

The builds are available for Mac (`.dmg`) and Windows (32 & 64 bit).

## Features

Currently, the following features are implemented:

- See all your servers with status

- Start / stop servers

- Open the server URL by clicking on the server

- Browse logs

- Handles Hotel configuration (host, port, TLD)

- Dark mode

In the future, I plan to add at least:

- Handling of edge cases (e.g. Hotel not installed)

- Custom config (per-server - such as opening URL, or global - theme)

## Contribution

- `git clone git@github.com:macav/hotelier.git`

- `cd hotelier`

- `yarn`

- `yarn start`

PRs are very welcome!

## Licence

**MIT** - Martin Cavoj