overseer/README.md

# Overseer

## Description
Overseer is a port scanning web interface. All current and historical results are stored in a database.

## Developing

### Server
Ideally from a virtualenv:
```
python setup.py develop
```

### Client
At this point, you have to build the client to appropriately populate the static resources for
the Flask server to serve up.

## Building
Overseer consists of a server and client component.

### Server:
Ideally from a virtualenv:
```
python setup.py install
```

### Client:
You must run these commands from the `./src/overseer_client/` directory:
```
yarn build
```

## Running

Ideally from a virtual env:
```
overseer run
```

# Notes
In a production environment, it would be ideal to setup something like nginx to properly forward
the `/api/*` routes to the Flask server, and all other endpoints to the static client resources.