novus

README

novus

A local HTTPS proxy for a delightful developer experience

Briefly introduce your CLI tool and its purpose. Explain how it helps developers deploy websites on localhost more efficiently.

Overview

• show an animation gif (defining routes in config file, then switch to console, and run novus serve)

• what it does, how it helps you

• combines mkcert, nginx and DNSMasq to provide a simple way to work with your local web applications using regular HTTPS URLs instead of several localhost addresses with different ports.

Install - #revisit#

Installing Novus is as simple as running

$ brew install novus

How to use

• when first running run with --create-config option
• then define your routes in the config

routes:
  - domain: my-frontend.test
    upstream: http://localhost:3000
  - domain: my-api.test
    upstream: http://localhost:5050
  - domain: my-search-api.test
    upstream: http://localhost:8000

• run novus serve

It will ask for your password as it performs some sudo calls (for managing DNS resolvers)

• run novus trust

Commands

Explain how to use your CLI tool, including command syntax and available options. Provide examples of common use cases to help users get started quickly.

• novus serve
• novus serve --create-config
• novus status
• novus stop
• novus trust

Notes

Do not use top level domains (TLD) defined by IANA This will result in redirecting all URLs using the given TLD to localhost e.g. my.local.website.com -> all .com websites will stop working

Instead, prefer .test or anything else that works for you

.local doesn't work (on MacOS) - Apple article recommend using .test

.dev - do not use either, this is now a valid TLD domain

License

Novus is released under the MIT license (LICENSE).