anthony
/
atol-online
mirror of https://github.com/anthonyaxenov/atol-online.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
atol-online/README.md

81 lines
4.1 KiB
Markdown
Raw Normal View History

Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
# АТОЛ Онлайн
Актуализирован readme
2021-12-19 14:58:47 +00:00
Библиотека для фискализации чеков по 54-ФЗ через [облачные ККТ АТОЛ](https://online.atol.ru/).
Корректировка readme
2021-12-02 08:14:01 +00:00
Исправлен README
2021-12-20 02:41:46 +00:00
[![GitHub Workflow Status (master)](https://img.shields.io/github/workflow/status/anthonyaxenov/atol-online/CI/master?logo=github)](https://github.com/anthonyaxenov/atol-online/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/anthonyaxenov/atol-online/branch/master/graph/badge.svg?token=WR2IV7FTF0)](https://codecov.io/gh/anthonyaxenov/atol-online)
[![Stable Version](https://img.shields.io/packagist/v/axenov/atol-online?label=stable)](https://packagist.org/packages/axenov/atol-online)
[![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/axenov/atol-online?color=%23787cb4)](https://packagist.org/packages/axenov/atol-online)
Мелочи по README
2022-08-13 13:59:01 +00:00
[![Liberapay](https://img.shields.io/liberapay/patrons/AnthonyAxenov.svg?logo=liberapay)](https://liberapay.com/AnthonyAxenov/donate)
Исправлен README
2021-12-20 02:41:46 +00:00
[![License](https://img.shields.io/packagist/l/axenov/atol-online?color=%23369883)](LICENSE)
Корректировка readme
2021-12-02 08:14:01 +00:00
**[Документация](/docs/readme.md)**
Warning in readme
2021-11-20 16:33:43 +00:00
Актуализирован readme
2021-12-19 14:58:47 +00:00
Текущие поддерживаемые версии АТОЛ Онлайн:
Warning in readme
2021-11-20 16:33:43 +00:00
Актуализирован readme
2021-12-19 14:58:47 +00:00
| Протокол | API | ФФД | Статус |
|----------|-----|------|----------------|
| v4 | 5.8 | 1.05 | Поддерживается |
| v5 | 2.0 | 1.2 | В планах |
Бейджик в readme + фикс composer.json
2020-05-27 17:14:53 +00:00
Правки по документации Актуализирована часть про `Vat`, пересобрал README, мелочи
2021-11-28 04:01:28 +00:00
## Плюшечки
* Мониторинг ККТ и ФН
Исправлен README
2021-12-20 02:41:46 +00:00
* Фискализация документов на облачной ККТ
Правки по документации Актуализирована часть про `Vat`, пересобрал README, мелочи
2021-11-28 04:01:28 +00:00
* Валидация данных до отправки документа на ККТ (насколько это возможно, согласно схеме)
* Расчёты денег в копейках
Исправлен README
2021-12-20 02:41:46 +00:00
* PSR-4 автозагрузка, покрытие настоящими тестами, fluent-setters, докблоки
Правки по документации Актуализирована часть про `Vat`, пересобрал README, мелочи
2021-11-28 04:01:28 +00:00
Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
## Системные требования
Мелочи по README
2022-08-13 13:59:01 +00:00
* `php v8.0` и выше
* `php-json`
* `php-curl`
* `php-mbstring`
* `php-tokenizer`
Правки по документации Актуализирована часть про `Vat`, пересобрал README, мелочи
2021-11-28 04:01:28 +00:00
* [composer](https://getcomposer.org/)
Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
## Начало работы
### Подключение библиотеки
Актуализирован readme
2021-12-19 14:58:47 +00:00
1. Подключить пакет к проекту:
Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
```bash
composer require axenov/atol-online
```
Правки по документации Актуализирована часть про `Vat`, пересобрал README, мелочи
2021-11-28 04:01:28 +00:00
2. В нужном месте проекта подключить автозагрузчик composer-зависимостей, если это не сделано ранее:
Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
```php
Правки по документации Актуализирована часть про `Vat`, пересобрал README, мелочи
2021-11-28 04:01:28 +00:00
require($project_root . '/vendor/autoload.php');
Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
```
Update README.md Добавлена версия API
2020-01-11 07:57:39 +00:00
где `$project_root` — абсолютный путь к корневой директории вашего проекта.
Правки по документации Актуализирована часть про `Vat`, пересобрал README, мелочи
2021-11-28 04:01:28 +00:00
> При использовании фреймворков это обычно не требуется.
Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
### Тестирование кода библиотеки
Файлы тестов находятся в директории `/tests` корня репозитория.
Настройка gh-actions для работы с codecov.io
2021-12-02 06:34:21 +00:00
Для запуска тестов необходимо перейти в корень репозитория и выполнить одну из команд:
Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
```bash
Настройка gh-actions для работы с codecov.io
2021-12-02 06:34:21 +00:00
composer test # обычное тестирование
Актуализирован readme
2021-12-19 14:58:47 +00:00
composer coverage # тестирование с покрытием
Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
```
Актуализирован readme
2021-12-19 14:58:47 +00:00
После тестирования с покрытием создаётся отчёт в директории `.coverage` в корне репозитория.
Настройка gh-actions для работы с codecov.io
2021-12-02 06:34:21 +00:00
Исправлен README
2021-12-20 02:41:46 +00:00
### Использование библиотеки
Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
Весь исходный код находится в директории [`/src`](/src).
Исправлен README
2021-12-20 02:41:46 +00:00
Вы имеете право использовать и распространять его на условиях **[лицензии MIT](LICENSE)**.
Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
Исправлен README
2021-12-20 02:41:46 +00:00
1. Обращайтесь к [документации библиотеки](/docs)
2. Обращайтесь к [исходному коду](/src) и описанным докблокам
3. Обращайтесь к [тестам](/tests/AtolOnline/Tests)
4. Используйте нормальную IDE
Initial commit, v0.1.0-b
2020-01-11 06:30:25 +00:00
## Дополнительные ресурсы
Мелочи в readme и phpunit.xml (удалены дефолтные параметры)
2021-12-01 17:10:54 +00:00
* [Документация АТОЛ Онлайн](https://online.atol.ru/lib/)
Liberapay shields in readme
2022-01-30 15:00:48 +00:00
[![Donate using Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/AnthonyAxenov/donate)