Skip to content

Commit

Permalink
Merge pull request #25 from pcnate/readme-update
Browse files Browse the repository at this point in the history
Readme update
  • Loading branch information
pcnate authored Dec 2, 2018
2 parents f97f384 + 2cfa154 commit 34d4733
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 10 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
# RED-AMPP

Developer tool for running micro services behind a redbird proxy.

Developer tool for running micro services behind a redbird proxy. Some CLI tools like Angular already provide a proxy mechanism. This one attempts to seperate from the source and provide more extensive abilities

>__WARNING:__
>
>This is only meant to run as a development tool on localhost. Please don't make it run on an external facing interface without adding some security.
>This is only meant to run as a development tool on localhost. Using it as a web facing tool is not recommended at this time

## Current Setup

* `git clone https://github.com/pcnate/red-ampp.git`
* `cd red-ampp`
* `npm install`
* `npm run build`
* `npm run prod`
* `npm install -g red-ampp`
* `red-ampp`

## Example

| Source | | Destination |
| ----------------------- | --- | --------------------------- |
| http://localhost/api | --> | http://localhost:3000/api |
| http://localhost/ | --> | http://localhost:4200 |
| http://localhost/other | --> | http://localhost:3001/other |
| http://localhost/remote | --> | http://otherserver/remote |


## Development Setup
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "red-ampp",
"version": "1.1.0",
"version": "1.1.1",
"description": "developer tool for running micro services behind a redbird proxy",
"main": "server.js",
"scripts": {
Expand Down

0 comments on commit 34d4733

Please sign in to comment.