baphomet-js/README.md

# Baphomet

Development Branch Tests: [![Concourse](https://concourse.nulloctet.com/api/v1/teams/nulloctet/pipelines/baphomet-js/jobs/test-develop/badge)](https://concourse.nulloctet.com/teams/nulloctet/pipelines/baphomet-js)

Master Branch Tests: [![Concourse](https://concourse.nulloctet.com/api/v1/teams/nulloctet/pipelines/baphomet-js/jobs/test-release/badge)](https://concourse.nulloctet.com/teams/nulloctet/pipelines/baphomet-js)

Baphomet is a bot to provide extended functionality to a matrix server

## Configuration

Copy data/config.json.example to data/config.json and replace the relevent configuration variables

## Running Bot

```bash
npm install
./entrypoint.sh run
```

## Development

### Requirements:

NodeJS 12 LTS

OR

Docker

#### Local:

```bash
npm install
#<make changes>
./scripts/run_development_local.sh
```

#### Docker:
```bash
#<make changes>
./scripts/run_development_docker.sh
```

## Contributing

See CONTRIBUTING.md

## License

See LICENSE.md