Project Structure

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

.
├── admin
├── config.example.ini
├── constants.inc.php
├── db
├── index.php
└── src

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. To keep track of DB schema changes we use Flyway as our migration tool. To read more about this see DataBase Migrations. If you need to see the current state of the data in your database, Adminer is included in the project. You can read more about it in SQLite Admin.

index.php

Entry point for Slack events.

src

All the classes required to run this project.