# local-domain

> A simple manager for working with .localhost proxies and more!

Latest version **0.0.3** (published 2019-06-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install local-domain
pnpm add local-domain
yarn add local-domain
bun add local-domain
```

Provides the command `local-domain`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2019-06-03 |
| First published | 2019-06-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 37 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ryan Tablada |
| Maintainers | rtablada |

## Links

- npm: https://www.npmjs.com/package/local-domain
- npm.io page: https://npm.io/package/local-domain

## Dependencies (1)

- [http-proxy](https://npm.io/package/http-proxy.md) ^1.17.0

## Recent versions

- 0.0.3 (latest) — 2019-06-03
- 0.0.2 — 2019-06-03
- 0.0.1 — 2019-06-03

## README

# Local Domain

> **WARNING** This project is under heavy development and flux. Config and things will likely change as the full feature set is built!

Local Domain is a quick and easy way to manage common tasks, local servers, and basic proxies for local development.

The ideal solution is to be able to start your day, go to `my-app.localhost`, from there Local Domain handles starting your Webpack server, proxies the request, and even lets you see logs.
All of this without touching docker, nGinx, PM2, or other tools!

This project is heavily inspired by [Hotel](https://www.npmjs.com/package/hotel) and [Laravel Valet](https://laravel.com/docs/5.8/valet).

### Getting Started

Install `local-domain` by running:

```
npm install -g local-domain
```

Then start the Local Domain server with:

```
local-domain
```

That's it for now!

To change configuration go to `~/.local-domain/config.json` and edit the `subdomains` array.
Each subdomain has two configuration values:

* `subdomain` - This is the subdomain that you want to use for your app within the `.localhost` TLD, for example a value of `my-app` will match for requests to `my-app.localhost`
* `port` - This is the port where your local server is running

> Example Subdomain Config Object

```json
{
  "subdomain": "api.weather",
  "port": 8080
}
```

Visiting `http://api.weather.localhost` will be like making a request to `http://localhost:8080` but all the right host headers, etc will still act like `api.weather.localhost`!

## Future Features

* CLI Commands
* Process Mangement (Local Domain can manage your servers Node or otherwise without you needing to run them in a separate task)
* SSL Certificates and HTTPS support (using no frills Let's Encrypt)
* GUI and Logs!
* Support for hooking into existing tools (docker, PM2, etc)

---
_Source: https://npm.io/package/local-domain · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._