QOTD Application

This application contains a slack bot that post a quote of the day to a slack channel.

The bot looks every morning for a new quote of the day and post it to the channel of your choice.

To elect the best QOTD, the bot will search for message with the most reactions. You can customize the searched reaction in the .env file.

This application is a fun project to learn how to use the following technologies:

Symfony
Symfony UX and some third party UX components
Advanced Doctrine and PostgreSQL usages (CTE, Window functions, Native Queries, Full Text Search, Pagination)

Installation

Configure the Slack Application

Create a new slack application with the manifest located in doc/slack-manifest.yaml.

Dont forget to customize the file with your own values.

Configure the Google application

You'll need a pair of Google API keys to connect via oAuth. You'll need to configure the following URLs as a callback: http://localhost:8000/connect/google/check. You'll also need to configure the emails domains allowed.

GOOGLE_CLIENT_ID=FIXME
GOOGLE_CLIENT_SECRET=FIXME
APP_ALLOWED_EMAIL_DOMAINS='["jolicode.com", "premieroctet.com"]'

But if you don't want to connect with google, you can use the YoloAuthenticator, see config/packages/security.yaml file.

Install the PHP application

To make the application available locally at the address http://localhost:8000, first create a docker-compose.override.yml file with the following content:

version: '3.7'

services:
    frontend:
        ports:
            - "8000:80"

[!NOTE] Override APP_DEFAULT_URI value in a .env.local file if you use another port or another domain.

Then run the following commands:

docker-compose up -d
docker-compose run --rm --user=app frontend composer install
docker-compose run --rm --user=app frontend bin/console asset-map:compile
docker-compose run --rm --user=app frontend bin/db
# If you want to load some fixtures
# docker-compose run --rm --user=app frontend bin/console doctrine:fixtures:load  --no-interaction
# configure remaining parameters in .env.local
# Enjoy

Development

If you want to contribute, you can edit the docker-compose.override.yml file to add:

services:
    frontend:
        volumes:
            - .:/app
        ports:
          - 8888:80

Usage

In slack you have one commands

/qotd [a date] to find the QOTD of the day or of the given date;

Credits

Thanks JoliCode for sponsoring this project.

jolicode / qotd

readme