README.md updated. Composer installation mentioned, unnecessary badges removed.
This commit is contained in:
parent
130495ea7c
commit
bf6cf9cbda
35
README.md
35
README.md
|
@ -1,8 +1,6 @@
|
||||||
[ ![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)
|
[ ![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)
|
[![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)
|
||||||
[![Scrutinizer Code Coverage](https://scrutinizer-ci.com/b/skobkin/point-tools/badges/coverage.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)
|
[![codecov](https://codecov.io/bb/skobkin/point-tools/branch/master/graph/badge.svg)](https://codecov.io/bb/skobkin/point-tools)
|
||||||
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/a54ef130-5aed-44f5-9ea9-c404a3d8db6b/mini.png)](https://insight.sensiolabs.com/projects/a54ef130-5aed-44f5-9ea9-c404a3d8db6b)
|
|
||||||
|
|
||||||
# Point Tools
|
# Point Tools
|
||||||
|
|
||||||
|
@ -14,20 +12,27 @@ Application setup is quite simple:
|
||||||
|
|
||||||
## Getting the source code
|
## Getting the source code
|
||||||
|
|
||||||
```shell
|
### Via Git
|
||||||
|
```bash
|
||||||
git clone https://skobkin@bitbucket.org/skobkin/point-tools.git
|
git clone https://skobkin@bitbucket.org/skobkin/point-tools.git
|
||||||
cd point-tools
|
cd point-tools
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Via Composer
|
||||||
|
```bash
|
||||||
|
composer create-project skobkin/point-tools -s dev
|
||||||
|
cd point-tools
|
||||||
|
```
|
||||||
|
|
||||||
## Setting file access privileges
|
## Setting file access privileges
|
||||||
Set up appropriate write privileges for `app/cache` and `app/logs`.
|
Set up appropriate write privileges for `app/cache` and `app/logs`.
|
||||||
|
|
||||||
## Installing dependencies
|
## Installing dependencies (not needed after installation via Composer)
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
# В dev-среде:
|
# In developer environment:
|
||||||
composer install
|
composer install
|
||||||
# В prod-среде
|
# In production environment
|
||||||
composer install --no-dev --optimize-autoloader
|
composer install --no-dev --optimize-autoloader
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -35,19 +40,19 @@ After dependencies installation you will be asked for database credentials of Po
|
||||||
|
|
||||||
## Database initialization
|
## Database initialization
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
php app/console doctrine:migrations:migrate
|
php app/console doctrine:migrations:migrate
|
||||||
```
|
```
|
||||||
|
|
||||||
## Web assets installation
|
## Web assets installation
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
php app/console assets:install web --symlink
|
php app/console assets:install web --symlink
|
||||||
```
|
```
|
||||||
|
|
||||||
## Adding CRON jobs
|
## Adding CRON jobs
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
crontab -e
|
crontab -e
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -61,13 +66,13 @@ You can use following jobs as an example:
|
||||||
|
|
||||||
## Setting Telegram webhook (to enable bot)
|
## Setting Telegram webhook (to enable bot)
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
php app/console telegram:webhook set your-domain.tld
|
php app/console telegram:webhook set your-domain.tld
|
||||||
```
|
```
|
||||||
|
|
||||||
## Removing Telegram webhook
|
## Removing Telegram webhook
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
php app/console telegram:webhook delete
|
php app/console telegram:webhook delete
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -75,7 +80,7 @@ php app/console telegram:webhook delete
|
||||||
|
|
||||||
## Configure environment variables
|
## Configure environment variables
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
export SYMFONY__TEST_DATABASE_USER=some_database_user
|
export SYMFONY__TEST_DATABASE_USER=some_database_user
|
||||||
export SYMFONY__TEST_DATABASE_PASSWORD=some_database_password
|
export SYMFONY__TEST_DATABASE_PASSWORD=some_database_password
|
||||||
export SYMFONY__TEST_DATABASE_NAME=some_database_name
|
export SYMFONY__TEST_DATABASE_NAME=some_database_name
|
||||||
|
@ -84,12 +89,12 @@ export SYMFONY__TEST_DATABASE_PORT=postgresql_port
|
||||||
|
|
||||||
## Load fixtures (if needed)
|
## Load fixtures (if needed)
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
php app/console doctrine:fixtures:load --no-interaction
|
php app/console doctrine:fixtures:load --no-interaction
|
||||||
```
|
```
|
||||||
|
|
||||||
## Run tests
|
## Run tests
|
||||||
|
|
||||||
```shell
|
```bash
|
||||||
phpunit -c app/
|
phpunit -c app/
|
||||||
```
|
```
|
Loading…
Reference in a new issue