Giter VIP home page Giter VIP logo

hotel's Introduction

hotel Mac/Linux Build Status Windows Build status

Classy process manager for web devs โค

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 and it works everywhere ๐Ÿ‘

Features

  • Shortcut access (http://localhost:2000/project)
  • Local domain support (http://project.dev *)
  • Servers are only started when you access them
  • Random or fixed ports
  • 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

(*) Local .dev domains are optional. If you want to use them, you need to configure your browser or network 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.

As a shortcut, you can also directly go to:

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

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 daemon
hotel stop      # Stop 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/servers/<app-name>.json

Third-party tools

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

License

MIT - Typicode

hotel's People

Contributors

typicode avatar rstacruz avatar therealklanni avatar djyde avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.