hotel

No need to worry about ports, remember commands, manage terminal tabs, ... access and start your servers from the browser. You can even use local .dev domains or any other tld, and it works everywhere (OS X, Linux, Windows) 👍

Features

Shortcut access (http://localhost:2000/project)
Local domain support (http://project.dev *)
SSL support via self-signed certificate (https://project.dev *)
Servers are only started when you access them
Works with any server (Node, Ruby, PHP, ...)
Cross-platform (OS X, Linux and Windows)
Plays nice with other servers (Apache, Nginx, ...)
No port 80 or admin/root privileges needed
Random or fixed ports
See Roadmap for upcoming features :)

* Local .dev domains are optional. To use them, configure your network or browser to use hotel's proxy auto-config file (proxy.pac). See instructions here.

Install

npm install -g hotel && hotel start

Quick start

Add your servers commands.

~/projects/one$ hotel add nodemon
~/projects/two$ hotel add 'serve -p $PORT'

Now, you can access, start and stop your servers from localhost:2000 or hotel.dev.

As a shortcut, you can also directly go to:

http://localhost:2000/one
http://localhost:2000/two

And

http://one.dev
http://two.dev

Other servers examples:

hotel add 'jekyll --port $PORT'
hotel add 'rails server --port $PORT'
hotel add 'python -m SimpleHTTPServer $PORT'
hotel add 'php -S 127.0.0.1:$PORT'
# ...

On Windows use "%PORT%" instead of '$PORT'

Usage

To add a server

hotel add <cmd> [opts]

# Examples:
hotel add 'nodemon app.js' -o out.log # Set output file (default: none)
hotel add 'nodemon app.js' -n name    # Set custom name (default: current dir name)
hotel add 'nodemon app.js' -p 3000    # Set a fixed port (default: random port)
hotel add 'nodemon app.js' -e PATH    # Store PATH environment variable in server config

To list, start and stop servers go to

http://localhost:2000

To start and access directly your server go to

http://localhost:2000/<app-name>

Other commands

hotel ls        # List servers
hotel rm [name] # Remove server
hotel start     # Start hotel daemon
hotel stop      # Stop hotel daemon

Port

For hotel to work, your servers need to listen on the PORT environment variable. Here are some examples showing how you can do it from your code or the command-line:

var port = process.env.PORT || 3000
server.listen(port)

hotel add 'cmd -p $PORT'  # OS X, Linux
hotel add "cmd -p %PORT%" # Windows

Dev domain support

See instructions here.

Configurations and logs

~/.hotel contains daemon log, servers and daemon configurations.

~/.hotel/conf.json
~/.hotel/daemon.log
~/.hotel/daemon.pid
~/.hotel/servers/<app-name>.json

Self-signed certificate

To use self-signed certificate, please put the cert and key to ~/.hotel/, and add key_path and cert_path to ~/.hotel.conf.json.

Example

{
  "port": 2000,
  "host": "127.0.0.1",
  "timeout": 5000,
  "tld": "dev",
  "key_path": ".hotel/hotel.key",
  "cert_path": ".hotel/hotel.crt"
}

Third-party tools

Hotel Clerk OS X menubar
HotelX Another OS X menubar (only 1.6MB)

Roadmap

In-browser logs
Sub-domains support

License

MIT - Typicode

floydwch/hotel