{"id":16703278,"url":"https://github.com/devaleks/kivi-angular8-example-app","last_synced_at":"2026-03-05T02:31:57.543Z","repository":{"id":38605720,"uuid":"225421508","full_name":"DevAleks/kivi-angular8-example-app","owner":"DevAleks","description":"Angular 8 Example App with JWT Auth + backend on PHP \u0026 MySQL + Unit \u0026 E2E testing + virtualization on Docker \u0026 Docker-Compose","archived":false,"fork":false,"pushed_at":"2023-01-07T14:56:04.000Z","size":63125,"stargazers_count":3,"open_issues_count":24,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-23T16:40:50.636Z","etag":null,"topics":["angular","angular8","crud","crud-application","docker","docker-compose","e2e","e2e-testing","e2e-tests","example","example-app","example-code","frontend","jasmine-karma","jasmine-protractor","jwt","php-mysql","typescript","unit-test","unittest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DevAleks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-02T16:36:14.000Z","updated_at":"2022-02-27T00:04:09.000Z","dependencies_parsed_at":"2023-02-07T11:32:22.350Z","dependency_job_id":null,"html_url":"https://github.com/DevAleks/kivi-angular8-example-app","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/DevAleks/kivi-angular8-example-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevAleks%2Fkivi-angular8-example-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevAleks%2Fkivi-angular8-example-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevAleks%2Fkivi-angular8-example-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevAleks%2Fkivi-angular8-example-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DevAleks","download_url":"https://codeload.github.com/DevAleks/kivi-angular8-example-app/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DevAleks%2Fkivi-angular8-example-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30107208,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T01:39:18.192Z","status":"online","status_checked_at":"2026-03-05T02:00:06.710Z","response_time":93,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angular8","crud","crud-application","docker","docker-compose","e2e","e2e-testing","e2e-tests","example","example-app","example-code","frontend","jasmine-karma","jasmine-protractor","jwt","php-mysql","typescript","unit-test","unittest"],"created_at":"2024-10-12T19:07:40.207Z","updated_at":"2026-03-05T02:31:57.524Z","avatar_url":"https://github.com/DevAleks.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://angular.io/\"\u003e\n    \u003cimg src=\"https://angular.io/assets/images/logos/angular/angular.svg\" alt=\"Logo\" width=\"72\" height=\"72\"\u003e\n  \u003c/a\u003e\n  \u003ch1 align=\"center\"\u003eKivi-App, демо приложение на Angular 8\u003c/h1\u003e\n\u003c/p\u003e\n  \n## Технологии  \n- [x] Frontend: Angular 8 и Typescript\n- [x] Backend: PHP и MySQL\n- [x] JWT Authentication c HTTP Interceptors, Guards\n- [x] Unit тестирование для Angular: Jasmine + Karma \n- [x] E2E тестирование: Jasmine + Protractor\n- [x] Виртуализация: Docker\n  \n\u003cbr /\u003e \n   \n## Приложение  \nПриложение Kivi-App представляет собой \"набросок\" будущего сайта с панелью администрирования и бекендом, включая CRUD взаимодействия между ними. \n- [x] Пользовательская часть сайта имеет 4 страницы:  \n * /  \n * /rafting  \n * /semeyniy-rafting  \n * /error404 (страница ошибки 404)      \nНа этих страницах можно оставлять заказы через 5 видов форм.    \n     \n- [x] Панель администрирования имеет систему авторизации через JWT Auth и 4 страницы:  \n * /admin/login (страница входа)\n * /admin/dashboard (страница со списком заказов с ссылками на изменение и удаление заказов)\n * /admin/create-order (страница создания нового заказа)\n * /admin/order/%ID заказа%/edit (страница изменения заказа)\nВ админпанели можно посмотреть список всех заказов, создавать новые заказы, а также редактировать и удалять уже имеющиеся.\n  \n\u003cbr /\u003e \n   \n### Frontend, элементы Angular  \n- [x] Компоненты  \n * Пользовательская часть: [frontend/src/app/shared/components/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/components/)\n * Админка: [frontend/src/app/admin/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/admin/)\n- [x] Сервисы   \n * Пользовательская часть: [frontend/src/app/shared/services/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/services/)\n * Админка: [frontend/src/app/admin/shared/services/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/admin/shared/services/)\n- [x] Pipe [frontend/src/app/shared/pipes/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/pipes/)\n- [x] Получение данных из Json файла [frontend/src/app/shared/components/first-block/first-block.component.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/components/first-block/first-block.component.ts) (строка 58)\n- [x] Роутеры:  \n * Пользовательской части [frontend/src/app/app-routing.module.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/app-routing.module.ts)\n * Админки с защитой роутов [frontend/src/app/admin/admin.module.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/admin/admin.module.ts)\n * AuthGuard [frontend/src/app/admin/shared/auth.guard.ts](https://github.com/DevAleks/kivi-angular8-example-app/blob/master/frontend/src/app/admin/shared/auth.guard.ts)\n- [x] Формы обратной связи, содержат валидатор с обработкой ошибок, выполняют отправку данных, получают и обрабатывают ответ от сервера:\n * Форма заказа 1 [frontend/src/app/shared/components/callorder-form/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/components/callorder-form/)\n * Форма заказа 2 [frontend/src/app/shared/components/first-form/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/components/first-form/)\n * Форма заказа 3 [frontend/src/app/shared/components/footer-form/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/components/footer-form/)\n * Форма заказа 4 [frontend/src/app/shared/components/question-form/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/components/question-form/)\n * Форма заказа 5 [frontend/src/app/shared/components/top-form/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/components/top-form/)\n * Форма входа в админку: [frontend/src/app/admin/login-page/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/admin/login-page/)  \n * Форма создания заказа в админке: [frontend/src/app/admin/create-order/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/admin/create-order/) \n * Кастомные валидаторы для форм: [frontend/src/app/shared/form.validators.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/form.validators.ts)\n- [x] Модули, 4 для пользовательских страниц приложения, 1 для админки и 2 для более удобной и оптимизированной группировки прочих сущностей Angular:\n * Главная страница: [frontend/src/app/main/main.module.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/main/main.module.ts)\n * Страница /rafting: [frontend/src/app/rafting/rafting.module.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/rafting/rafting.module.ts)\n * Страница /semeyniy-rafting: [frontend/src/app/semeyniy-rafting/semeyniy-rafting.module.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/semeyniy-rafting/semeyniy-rafting.module.ts)\n * Страница ошибки 404: [frontend/src/app/error404/error404.module.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/error404/error404.module.ts)\n * Модуль для основных сущностей: [frontend/src/app/shared/shared.module.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/shared.module.ts)\n * Модуль для доп. сущностей на 3-х основных страницах: [frontend/src/app/shared/pages.module.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/pages.module.ts)\n * Модуль для панели администрирования: [frontend/src/app/admin/admin.module.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/admin/admin.module.ts)\n- [x] Механизм авторизации через JWT токены для админки: \n * Получение токена, его хранение в Local Storage и удаление токена\n * Проверка валидности токена\n * Обработка ошибок    \n[frontend/src/app/admin/shared/services/auth.service.ts](https://github.com/DevAleks/kivi-angular8-example-app/blob/master/frontend/src/app/admin/shared/services/auth.service.ts)\n- [x] Интерсептор для проверки валидности текущего токена в админке: [frontend/src/app/shared/auth.interceptor.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/auth.interceptor.ts) \n- [x] Ленивая загрузка изображений в пользовательской части с [ng-lazyload-image](https://github.com/tjoskar/ng-lazyload-image) и youtube видео с помощью директивы [inView](https://github.com/DevAleks/kivi-angular8-example-app/blob/master/frontend/src/app/shared/inview.directive.ts) \n- [x] WYSIWYG редактор [ngx-quill](https://www.npmjs.com/package/ngx-quill) для формы создания новых заказов в админке\n- [x] Пагинация на странице списка заказов [frontend/src/app/admin/dashboard-page/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/admin/dashboard-page/) с помощью [jw-angular-pagination](https://github.com/cornflourblue/jw-angular-pagination)\n- [x] Ru локализация в date pipe на странице списка заказов [frontend/src/app/admin/dashboard-page/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/admin/dashboard-page/)\n- [x] Поддержка PWA. Если собрать приложение в режиме prodact, то оно будет работать как PWA, с использованием встроенного Service Worker\n- [x] Вывод тегов \u003cscript ...\u003e в шаблонах. Обеспечивающий компонент [frontend/src/app/shared/components/scripthack](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/shared/components/scripthack) и пример вывода тега в шаблоне [frontend/src/app/components/subscribe-block/subscribe-block.component.html](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/components/subscribe-block/subscribe-block.component.html)\n- [x] Вывод видео с Youtube, url видео загружается из JSON файла [frontend/src/app/shared/components/video-block/](https://github.com/DevAleks/kivi-angular8-example-app/tree/master/frontend/src/app/shared/components/video-block/)\n    \n### Тестирование frontend\n- [x] Unit тестирование пользовательской части приложения Jasmine + Karma\n- [x] End-to-end тестирование пользовательской части приложения Jasmine + Protractor\n    \n### Backend \n- [x] Бекенд работает на PHP и MySQL.    \n * В пользовательской части сайта обработка данных из форм заказа производится PHP скриптом: [backend/requests.add.php](https://github.com/DevAleks/Kivi/tree/master/backend/requests.add.php). При корректном выполнении сценария данные из форм записываются в БД на MySQL. Также PHP скрипт модифицирует полученные данные перед отправкой их обратно на frontend, что служит маркером успешного получения и обработки этих данных бекендом. При ошибке записи данных в БД сервер также отправляет на frontend сообщение о возникшей проблеме.    \n * Панель администрирования обменивается данными с бекендом через 4 endpoints:  \n  * Страница входа в админку (/admin/login), endpoint: [backend/jwt/api/login.php](https://github.com/DevAleks/Kivi/tree/master/backend/jwt/api/login.php)  \n  * Страница списка заказов (/admin/dashboard), endpoint: [backend/jwt/api/get_orders.php](https://github.com/DevAleks/Kivi/tree/master/backend/jwt/api/get_orders.php) \n  * Страница создания нового заказа (/admin/create-order), endpoint: [backend/jwt/api/create_order.php](https://github.com/DevAleks/Kivi/tree/master/backend/jwt/api/create_order.php)  \n  * Страница редактирования заказа (admin/order/%id заказа%/edit), endpoint: [backend/jwt/api/update_order.php](https://github.com/DevAleks/Kivi/tree/master/backend/jwt/api/update_order.php)    \nА также функция удаления заказа через [backend/jwt/api/delete_order.php](https://github.com/DevAleks/Kivi/tree/master/backend/jwt/api/delete_order.php)  \n- [x] Аутентификация c токенами через [библиотеку JWT](https://github.com/firebase/php-jwt) \n  \n### Виртуализация \n- [x] Выполнена на Docker и Docker-Compose\n- [x] 2 Dockerfile для:\n * frontend [frontend/Dockerfile](https://github.com/DevAleks/Kivi/tree/master/frontend/Dockerfile)\n * backend [backend/Dockerfile](https://github.com/DevAleks/Kivi/tree/master/backend/Dockerfile)\n- [x] 3 конфига Docker-Compose, используемых для:  \n * разработки приложения [docker-compose.yaml](https://github.com/DevAleks/Kivi/tree/master/docker-compose.yaml)  \n * Unit тестирования [dc-angular-unit-tests.yaml](https://github.com/DevAleks/Kivi/tree/master/dc-angular-unit-tests.yaml)  \n * E2E тестирования [dc-angular-e2e-tests.yaml](https://github.com/DevAleks/Kivi/tree/master/dc-angular-e2e-tests.yaml)  \n  \n\u003cbr /\u003e  \n\n## Инсталяция и запуск\nДля работы с приложением рекомендуется использовать Docker, под него сделаны все необходимые настройки для совместной работы frontend и backend. Инсталяция и запуск приложения описаны для Docker. \n1. Склонировать приложение.  \n2. Установить зависимости:  \n ```bash\n docker run --rm -v ${PWD}/frontend/:/opt/kivi -w /opt/kivi node:12 npm install\n ```\n3. Первый запуск и build образа:  \n ```bash\n docker-compose up --build -d\n ```\nПоследующие запуски:  \n ```bash\n docker-compose up -d\n ```\n4. Создание рабочей БД kiviapp для приложения.\nСоздание структуры БД kiviapp и пользователя админки admin@kiviapp.com / 11111111 возможно 2-мя способами:\n* Запустив скрипт: http://localhost:80/create.new.table.php \n* Через PhpMyAdmin, http://localhost:8081/ (root / root), запросы с таблицами лежат в файле [backend/create.new.table.php](https://github.com/DevAleks/Kivi/tree/master/backend/create.new.table.php))  \n  \n### Остановка приложения\n ```bash\n docker-compose kill\n ```  \n  \n\u003cbr /\u003e \n  \n## Функционал приложения\n  \n### Демонстрация возможностей приложения  \n1. Вход в пользовательску часть: http://localhost:4200/. Здесь можно заполнить и отправить любую форму обратной связи. Если данные из корректно заполненной формы успешно попали на сервер, то появится сообщение об успешной отправке запроса.  \n2. Вход в панель администрирования: http://localhost:4200/admin/login (admin@kiviapp.com / 11111111). Здесь можно создать новый заказ на странице \"Новый заказ\", а также редактировать или удалять уже созданные заказы. \n  \n### Формы обратной связи в пользовательской части\nНа каждой станице есть 5 различных форм обратной связи, позволяющих посетителям отправлять заказы услуг. 4 формы в модальных окнах доступны по кнопкам:  \n * Заказать звонок (шапка)  \n * Задать вопрос (шапка)  \n * Заказать (шапка)  \n * Заказать сейчас (контент)  \nПятая форма расположена внизу страницы.  \n  \nКаждая форма умеет проверять введенные данные и подсказывать какие ошибки ввода нужно исправить, если они есть. Если все данные введены корректно, то форма пытается отправить их на сервер и ждет его ответ. После получения ответа сервера он выводится на экран. Как пример обработки ошибок могут быть 3 варианта ответа:  \n* Отправка данных прошла успешно  \n* Отправить данные не удалось  \n* Сервер неверно обработал полученные данные  \n  \n\u003cbr /\u003e   \n  \n## Unit тестирование  \nТестами покрыто примерно 80% всех функций модуля сайта (app.module.ts). Код тестов содержится рядом с кодом приложения: [frontend/src/app/](https://github.com/DevAleks/Kivi/tree/master/frontend/src/app/)  \n  \n### Работа с Unit тестами (через Docker и Docker-Compose)  \n1. Запуск:  \n ```bash\n docker-compose -f dc-angular-unit-tests.yaml up -d \n ```  \nДалее открыть вкладку браузера: http://localhost:9876/, ждем 10-15 секунд и перегружаем ее (в некоторых случаях 2-3 раза). Если все сработало, то во вкладке должна отобразиться информация о ходе тесирования.    \nДля повторного запуска тестов нужно перезагрузить эту же вкладку браузера.    \n  \n2. Остановка и очистка контейнеров Docker после завершения Unit тестирования:  \n ```bash\n docker-compose -f dc-angular-unit-tests.yaml kill\n docker-compose -f dc-angular-unit-tests.yaml down \n ```  \n  \n\u003cbr /\u003e   \n  \n## E2E тестирование  \nРазбито на 2 части. Покрыты только некоторые элементы страницы и проверены 3 коротких use case для форм обратной связи.\nКод тестов расположен тут: [frontend/e2e/src/](https://github.com/DevAleks/Kivi/tree/master/frontend/e2e/src/)  \n  \n### Первая часть, элементы страницы\nТестами покрыта генерация различных типов элементов:  \n* Обычные элементы из шаблонов компонентов  \n* Элементы, подгружаемые из JSON файла при загрузке приложения  \n* Проверка корректность работы \"карусели\" и перехода по ссылке на другую страницу.  \n  \nПуть: [frontend/e2e/src/app-kivi-default.e2e-spec.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/e2e/src/app-kivi-default.e2e-spec.ts)  \n  \n### Вторая часть, формы обратной связи  \nВыполняется проверка 3 сценариев:  \n1. Открытие/закрытие модального окна одной из форм  \n2. Обработка 2-х ошибок корректности заполнения формы  \n3. Отправка валидных данных на работающий и неработающий backend. Т.е. при работающем или неработающем backend один из тестов будет не пройден.  \n  \nПуть: [frontend/e2e/src/app-kivi-test-form.e2e-spec.ts](https://github.com/DevAleks/Kivi/tree/master/frontend/e2e/src/app-kivi-test-form.e2e-spec.ts)  \n  \n### Работа с E2E тестами (через Docker и Docker-Compose)  \n1. Первый запуск с созданием образа:  \n ```bash\n docker-compose -f dc-angular-e2e-tests.yaml up --build -d\n ``` \n  Последующие запуски:  \n ```bash\n docker-compose -f dc-angular-e2e-tests.yaml up -d\n ```  \n2. Результаты тестов запишутся в файл frontend/logs.txt  \n3. Остановка и очистка контейнеров Docker:  \n ```bash\n docker-compose -f dc-angular-e2e-tests.yaml kill\n docker-compose -f dc-angular-e2e-tests.yaml down\n ``` \n  \nВнимание! Используемый для Е2Е тестов Docker образ trion/ng-cli-e2e работает некорректно с тестами, связанными с передачей запросов на backend. Это тесты:  \n* Use case 3 (send valid data to working server): should have success message  \n* Use case 3 (send valid data to broken server): should have error server data sending message  \n  \nРешает проблему запуск Е2Е тестов локально:  \n ```bash\n ng e2e\n ``` \nПри этом можно воспользоваться запущенными в Docker контейнерами с PHP и MySQL.    \n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevaleks%2Fkivi-angular8-example-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevaleks%2Fkivi-angular8-example-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevaleks%2Fkivi-angular8-example-app/lists"}