typicode/hotel is tracked by TopGit as an open-source project, with 10.0k stars on GitHub, written primarily in JavaScript. 🏩 A simple process manager for developers. Start apps from your browser and access them using local domains
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
To use local .localhost domains, you need to configure your network or browser to use hotel's proxy auto-config file or you can skip this step for the moment and go directly to http://localhost:2000
See instructions here.
Add your servers
# Add your server to hotel
~/projects/one$ hotel add 'npm start'
# Or start your server in the terminal as usual and get a temporary local domain
~/projects/two$ hotel run 'npm start'
Visit localhost:2000 or http(s)://hotel.localhost.
Using other servers? Here are some examples to get you started :)
hotel add 'ember server' # Ember
hotel add 'jekyll serve --port $PORT' # Jekyll
hotel add 'rails server -p $PORT -b 127.0.0.1' # Rails
hotel add 'python -m SimpleHTTPServer $PORT' # static file server (Python)
hotel add 'php -S 127.0.0.1:$PORT' # PHP
hotel add 'docker-compose up' # docker-compose
hotel add 'python manage.py runserver 127.0.0.1:$PORT' # Django
# ...
On Windows use "%PORT%" instead of '$PORT'
See a Docker example here..
Proxy requests to remote servers
Add your remote servers
~$ hotel add http://192.168.1.12:1337 --name aliased-address
~$ hotel add http://google.com --name aliased-domain
You can now access them using
http://aliased-address.localhost # will proxy requests to http://192.168.1.12:1337
http://aliased-domain.localhost # will proxy requests to http://google.com
CLI usage and options
hotel add <cmd|url> [opts]
hotel run <cmd> [opts]
# Examples
hotel add 'nodemon app.js' --out dev.log # Set output file (default: none)
hotel add 'nodemon app.js' --name name # Set custom name (default: current dir name)
hotel add 'nodemon app.js' --port 3000 # Set a fixed port (default: random port)
hotel add 'nodemon app.js' --env PATH # Store PATH environment variable in server config
hotel add http://192.168.1.10 --name app # map local domain to URL
hotel run 'nodemon app.js' # Run server and get a temporary local domain
# Other commands
hotel ls # List servers
hotel rm # Remove server
hotel start # Start hotel daemon
hotel stop # Stop hotel daemon
To get help
hotel --help
hotel --help <cmd>
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
Fallback URL
If you're offline or can't configure your browser to use .localhost domains, you can always access your local servers by going to localhost:2000.
Configurations, logs and self-signed SSL certificate
By default, hotel uses the following configuration values:
{
"port": 2000,
"host": '127.0.0.1',
// Timeout when proxying requests to local domains
"timeout": 5000,
// Change this if you want to use another tld than .localhost
"tld": 'localhost',
// If you're behind a corporate proxy, replace this with your network proxy IP (example: "1.2.3.4:5000")
"proxy": false
}
To override a value, simply add it to ~/.hotel/conf.json and run hotel stop && hotel start
Third-party tools
Hotelier Hotelier (Mac & Windows Tray App)
Hotel Clerk OS X menubar
HotelX Another OS X menubar (only 1.6MB)
alfred-hotel Alfred 3 workflow
Hotel Manager Gnome Shell extension
FAQ
Setting a fixed port
hotel add --port 3000 'server-cmd $PORT'
Adding X-Forwarded-* headers to requests
hotel add --xfwd 'server-cmd'
Setting HTTP_PROXY env
Use --http-proxy-env flag when adding your server or edit your server configuration in ~/.hotel/servers
hotel add --http-proxy-env 'server-cmd'
Proxying requests to a remote https server
hotel add --change-origin 'https://jsonplaceholder.typicode.com'
When proxying to a https server, you may get an error because your .localhost domain doesn't match the host defined in the server certificate. With this flag, host header is changed to match the target URL.
ENOSPC and EACCES errors
If you're seeing one of these errors in ~/.hotel/daemon.log, this usually means that there's some permissions issues. hotel daemon should be started without sudo and ~/.hotel should belong to $USER.
# to fix permissions
sudo chown -R $USER: $HOME/.hotel
See also, https://docs.npmjs.com/getting-started/fixing-npm-permissions
Configuring a network proxy IP
If you're behind a corporate proxy, replace "proxy" with your network proxy IP in ~/.hotel/conf.json. For example:
The most recent commit recorded on typicode/hotel was 3.1 years ago, based on the GitHub push timestamp. The repository has 440 forks — one of the better signals of community interest.
How many stars does typicode/hotel have?
typicode/hotel has 10.0k GitHub stars — refresh the page for the live number, or check github.com/typicode/hotel. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What is typicode/hotel?
typicode/hotel (typicode/hotel) is a JavaScript project on GitHub. From the project's own README: 🏩 A simple process manager for developers. Start apps from your browser and access them using local domains
What language is typicode/hotel written in?
typicode/hotel is written primarily in JavaScript. GitHub's language field is based on the largest share of bytes in the default branch.
What topics is typicode/hotel associated with?
GitHub's repository topics for typicode/hotel: "devtools", "front-end", "https", "local", "local-domain", "process-manager", "proxy". TopGit's editorial category is open-source.
Read full README in the tab above.
Still deciding about hotel?
One click hands the question to an AI along with this page — see what it says about hotel.