Skip to content

Instantly share code, notes, and snippets.

@CrabDude

CrabDude/README.md

Created September 30, 2016 09:59
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save CrabDude/912a8845af7f218731c689dcfbf29d2f to your computer and use it in GitHub Desktop.
Save CrabDude/912a8845af7f218731c689dcfbf29d2f to your computer and use it in GitHub Desktop.
Download ZIP
An example of a proper README.md for submission.
Raw
README.md

Proxy Server

This is a Proxy Server for Node.js submitted as the pre-work requirement for the Node.js Bootcamp.

Time spent: 3h

Completed:

  • Required: Requests to port 8000 are echoed back with the same HTTP headers and body
  • Required: Requests/reponses are proxied to/from the destination server
  • Required: The destination server is configurable via the --host, --port or --url arguments
  • Required: The destination server is configurable via the x-destination-url header
  • Required: Client requests and respones are printed to stdout
  • Required: The --logfile argument outputs all logs to the file specified instead of stdout
  • Optional: The --exec argument proxies stdin/stdout to/from the destination program
  • Optional: The --loglevel argument sets the logging chattiness
  • Optional: Supports HTTPS
  • Optional: -h argument prints CLI API

Walkthrough Gif: Video Walkthrough

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment