point-tools/README.md
2017-01-11 05:22:34 +03:00

102 lines
2.6 KiB
Markdown

[ ![Codeship Status for skobkin/point-tools](https://app.codeship.com/projects/bb9fe730-a175-0134-5572-12490b0b4938/status?branch=master)](https://app.codeship.com/projects/189850)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/b/skobkin/point-tools/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/b/skobkin/point-tools/?branch=master)
[![codecov](https://codecov.io/bb/skobkin/point-tools/branch/master/graph/badge.svg)](https://codecov.io/bb/skobkin/point-tools)
[![Total Downloads](https://poser.pugx.org/skobkin/point-tools/downloads)](https://packagist.org/packages/skobkin/point-tools)
[![License](https://poser.pugx.org/skobkin/point-tools/license)](https://packagist.org/packages/skobkin/point-tools)
# Point Tools
Point Tools is a service which provides additional features for [Point.im](https://point.im/) microblog users.
# Installation
Application setup is quite simple:
## Getting the source code
### Via Git
```bash
git clone https://skobkin@bitbucket.org/skobkin/point-tools.git
cd point-tools
```
### Via Composer
```bash
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)
```bash
# 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
```bash
php app/console doctrine:migrations:migrate
```
## Web assets installation
```bash
php app/console assets:install web --symlink
```
## Adding CRON jobs
```bash
crontab -e
```
You can use following jobs as an example:
```crontab
# 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
```
## Setting Telegram webhook (to enable bot)
```bash
php app/console telegram:webhook set your-domain.tld
```
## Removing Telegram webhook
```bash
php app/console telegram:webhook delete
```
# Running tests
## Configure environment variables
```bash
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
```
## Load fixtures (if needed)
```bash
php app/console doctrine:fixtures:load --no-interaction
```
## Run tests
```bash
phpunit -c app/
```