Project Structure

The folowing block shows some of the files and folders in this project.

.
├── admin
├── config.example.ini
├── constants.inc.php
├── db
│   ├── bootstrap.php
│   └── phpmxbot.sql
├── index.php
└── src
    ├── MessageHandler.php
    └── PlusPlusHandler.php

admin

Self contained SQLite admin UI. Built with Adminer.

config.example.ini

Example configuration file. Used by ./bootstrap.sh to create config.ini. Project configuration including Slack token and DB paths.

db

SQLite folder. The database is not contained in the repo, instead it is generated automatically when running ./bootstrap.sh. The file bootstrap.php is used to initialize your local file, and phpmxbot.sql contains the necessary SQL statements to accomplish this task, including a special string %%PASSWORD_HASH%% that will be replaced with your password choice.

index.php

Entry point for Slack events.

src

All the classes required to run this project.