Corvus/server/README.md

# Corvus Server

## [API Documentation](https://warricksothr.gitlab.io/Corvus)

## Requirements

* Python 3.6
* Pipenv

## Installation

```bash
git clone https://gitlab.com/WarrickSothr/Corvus.git
cd Corvus/server
pipenv install
pipenv shell
```

## Configuration

Specify a settings file

```bash
export SERVER_SETTINGS='<path to settings python file>'
```

## Running

### Docker

```bash
docker build -t corvus:local-test .
docker run -d corvus:local-test
```

### Local Development Version

Run a local version

```bash
FLASK_APP=corvus:corvus flask db upgrade
python manage.py user register-admin
FLASK_APP=corvus:corvus flask run
```

Set log level

```bash
export SERVER_LOGLEVEL=DEBUG
```

## FAQ

## Development

```bash
pipenv install --dev
```

* Make changes
* Add/Update tests

```bash
./run_tests
```

* If everything passes follow contributing guide.

## Testing

To run the pytests directly, use the following command

```bash
PYTHONPATH=$(pwd) pipenv run py.test
```

## Contributing

See ../CONTRIBUTING.md