up-serve/README.md

quick nginx server blocks in one command

up

Current version: up v.0.1.0 (Pre-Alpha)

Notes: up has landed in pre-alpha! 🎉 Changelog will be added from up v.0.2.0 (Alpha/MVP)
⚠️ ❌ up is still not ready for use yet! Do not attempt to use this in development or production until alpha!

up is a command line application that creates nginx server blocks quickly with a single command.

Installation

As of now, up only supports Debian and Ubuntu based distros. Support for more distros will come soon. Add an issue to bump this process.

You will need to have node JS and nginx installed.

⚠️ ❌ You have been warned that up is still in development. If you intend to install it for development, follow these instructions:

git clone https://github.com/codefeathers/up-serve

cd up-serve

npm install

npm install -g

up is now available as a command.

Alternatively, install from npm:

npm i -g up-serve

up is now available as a command.

Commands

up static <domain> - Create new static server at current folder.

up proxy <domain> <port> - Create new proxy server listening at said port.

up list - List currently available servers.

up kill <domain> - Kill the server for this domain.

Examples

up static example.com will serve a static website from current folder.

up proxy example.com 8081 will create a reverse proxy listening at port 8081.

Contributors, Collaborators, and Guides

Plenty of people gave their time guiding me and shaping this tool.

I'd like to thank and give credit to [https://thedevs.network](The Devs Community), who are the primary reason this exists.

I'd also personally thank the following amazing people for their valuable support and feedback: Pouria Ezzati, Thomas Rory Gummerson, Omar Khalil, Martin, Faizan Akram.

And the following people for their moral support and listening to my constant bickering: David (The Humanoid), Иброхеем, Simon 'SitiSchu' Schürrle.