skobkin/point-tools

3rd party service for Point.im users

dev-master / 3.4.x-dev 2020-04-29 14:22 UTC

Requires

• php: >=7.1.0
• ext-json: *
• csa/guzzle-bundle: ^3
• doctrine/annotations: ^1.3.0
• doctrine/doctrine-bundle: ^1.6
• doctrine/doctrine-cache-bundle: ^1.2
• doctrine/doctrine-migrations-bundle: ^1.0
• doctrine/orm: ^2.5
• incenteev/composer-parameter-handler: ^2.0
• jms/serializer-bundle: ^2
• knplabs/knp-markdown-bundle: ^1.4
• knplabs/knp-paginator-bundle: ^2.5
• ob/highcharts-bundle: ^1.2
• sensio/distribution-bundle: ^5.0.19
• sensio/framework-extra-bundle: ^5.0.0
• sentry/sentry-symfony: ^2.2
• symfony/monolog-bundle: ^3.1.0
• symfony/swiftmailer-bundle: ^2.6.4
• symfony/symfony: ^3.4
• symfony/web-server-bundle: ^3.3
• twig/extensions: ~1.0
• twig/twig: ^2.0
• unreal4u/telegram-api: ^2.2

Requires (Dev)

• doctrine/doctrine-fixtures-bundle: ^2.3
• phpunit/phpunit: ^5.7
• symfony/phpunit-bridge: ^3.0

MIT

README

Point Tools

Point Tools is a service which provides additional features for Point.im microblog users.

Installation

Application setup is quite simple:

Getting the source code

Via Git

git clone https://[e-mail]/skobkin/point-tools.git
cd point-tools

Via Composer

composer create-project skobkin/point-tools -s dev
cd point-tools

Setting file access privileges

Set up appropriate write privileges for app/cache and app/logs.

Installing dependencies (not needed after installation via Composer)

# In developer environment:
composer install
# In production environment
composer install --no-dev --optimize-autoloader

After dependencies installation you will be asked for database credentials of PostgreSQL database and some other application parameters.

Database initialization

php app/console doctrine:migrations:migrate

Web assets installation

php app/console assets:install web --symlink

Adding CRON jobs

crontab -e

You can use following jobs as an example:

# point.skobk.in
*/10 * * * * /usr/bin/php /path/to/point-tools/app/console point:update:subscriptions --env=prod
0 0 * * * /usr/bin/php /path/to/point-tools/app/console point:update:subscriptions --all-users --env=prod

See app/crontab for more advanced usage.

Setting Telegram webhook (to enable bot)

php app/console telegram:webhook set

Removing Telegram webhook

php app/console telegram:webhook delete

Running tests

Configure environment variables

export SYMFONY__TEST_DATABASE_USER=some_database_user
export SYMFONY__TEST_DATABASE_PASSWORD=some_database_password
export SYMFONY__TEST_DATABASE_NAME=some_database_name
export SYMFONY__TEST_DATABASE_PORT=postgresql_port
export SYMFONY_ENV=test

Load fixtures (if needed)

php app/console doctrine:fixtures:load --no-interaction

Run tests

phpunit -c app/