Ознайомтеся з документацією »
Повідомити про помилку · Запропонувати функцію · Задати питання
Зміст
Pet-Project KIT - це GitHub репозиторій, який спрощує запуск і розвиток пет-проектів для команди - дизайнера, фронтенда та бекенда. Мета цього репозиторію - надати шаблон, який допоможе швидко розпочати роботу, забезпечуючи при цьому єдиний підхід до організації коду, документації та процесів розробки.
Docker — це інструмент, який дозволяє розробникам, тестувальникам і адміністраторам систем легко створювати, розгортати та запускати додатки в контейнерах. Це забезпечує консистентність середовища від розробки до продакшену, спрощує CI/CD процеси та допомагає у вирішенні проблеми "у мене працює, а в тебе — ні".
Nginx — це високопродуктивний HTTP-сервер та обернений проксі-сервер, а також IMAP/POP3 проксі-сервер. Його використовують для підвищення масштабованості веб-додатків завдяки асинхронній архітектурі. Він широко відомий своєю стабільністю, низьким споживанням ресурсів та високою гнучкістю конфігурації.
Альтернативи для Nginx:
- Apache — традиційний вибір для веб-серверів, пропонує більше модулів та гнучкість.
- Caddy — автоматично надає HTTPS, легкий у налаштуванні.
На продакшені в облаках:
- AWS пропонує Elastic Load Balancing (ELB).
- Azure використовує Application Gateway.
- GCP пропонує Cloud Load Balancing.
MongoDB — це документо-орієнтована база даних NoSQL, яка забезпечує високу производительність, високу доступність та легкість масштабування. Вона ідеально підходить для зберігання структурованих та неструктурованих даних з гнучкою схемою документів.
Альтернативи для MongoDB:
- PostgreSQL — потужна відкрита система управління реляційними базами даних, яка підтримує як SQL, так і JSON-подібні документні дані.
- MySQL — популярна система управління базами даних, широко використовується у веб-додатках.
- CouchDB — база даних, яка використовує JSON для зберігання даних, JavaScript для запитів, а HTTP для API.
На продакшені в облаках:
- AWS надає Amazon RDS та Amazon Aurora.
- Azure пропонує Azure SQL Database.
- GCP пропонує Cloud SQL.
Ознайомтеся з інструкціями для розробки та запуску проекту:
Ця директорія призначена для зберігання всіх дизайн-ресурсів проекту.
- Як використовувати: Додайте сюди макети інтерфейсу, логотипи та будь-які інші графічні матеріали. Використовуйте назви файлів, які чітко описують їх зміст, наприклад,
main-page-layout.png.
Директорія для технічної документації вашого проекту.
- Як використовувати: Зберігайте тут документи, що описують архітектуру системи, вибрані технології, налаштування середовища тощо.
Використовуйте цю папку для протоколів зустрічей команди та будь-яких інших нотаток, пов'язаних з обговоренням проекту.
- Як використовувати: Додавайте файли з підсумками зустрічей, планами на майбутнє, обговореними ідеями. Це допоможе утримувати всю команду на одній хвилі та зберігати історію рішень.
Файл для зберігання інформації про учасників проекту.
- Як використовувати: Оновлюйте цей файл, додаючи контактні дані нових учасників проекту, їх ролі та короткий опис внеску кожного в проект.
Для локального розгортання проєкту використовуйте docker-compose.yml, який забезпечує зручне управління сервісами через Docker. Це ідеальний інструмент для організації і запуску вашого додатку в однорідному середовищі, незалежно від локальної ОС.
-
Встановлення Docker
- Завантажте та встановіть Docker Desktop або Docker Engine, залежно від вашої ОС. Це дозволить вам створювати та управляти контейнерами на вашій машині.
-
Запуск Docker Compose
- Відкрийте термінал у директорії проекту, де знаходиться
docker-compose.ymlі виконайте наступну команду:docker-compose up
- Ця команда створить та запустить всі необхідні контейнери, визначені в конфігураційному файлі.
- Відкрийте термінал у директорії проекту, де знаходиться
-
Запуск Docker Compose
- **`/src/frontend/Dockerfile`**:
- Тут розміщуються фронтенд частини проекту, які налаштовують середовище відповідно до потреб фронтенду.
- **`/src/backend/Dockerfile`**:
- Тут розміщуються бекенд частини проекту, які налаштовують середовище відповідно до потреб бекенду.
- **`/src`**:
- Тут розміщені конфігураційні файли, які використовуються для налаштування цих сервісів в рамках Docker контейнерів.
- Перевірка роботи
- Після успішного запуску контейнерів, ви зможете переглянути ваш додаток у дії, відкривши веб-браузер та навігувавши до вказаної URL-адреси, якщо така передбачена налаштуваннями вашого додатку.
- Для більш детальної інформації про конфігурацію та використання
docker-compose, відвідайте офіційну документацію Docker. - В разі виникнення проблем з Docker, зверніться до секції вирішення проблем на сайті Docker.
Ці кроки допоможуть вам безперешкодно розпочати роботу з вашим проєктом, забезпечуючи стабільне та контрольоване середовище розробки.
docs/- документація проєкту та дизайни.src/- вихідний код проєкту, включаючи конфігураційні файли, фронтенд і бекенд.tests/- тести для фронтенду та бекенду.deployment/- налаштування для розгортання на AWS, Azure, GCP.scripts/- утиліти та скрипти для автоматизації.designs/- графічні матеріали проєкту (статика).
Більш детальну інформацію про кожну з директорій ви можете знайти в структурі проєкту.
Якщо у вас є запитання або потрібна допомога, використовуйте розділ Issues на GitHub.
Ми завжди раді новим учасникам. Якщо ви хочете внести свій вклад, будь ласка, перегляньте CONTRIBUTING.md, і якщо вам подобається наш проект, будь ласка, поставте нам зірочку, щоб підтримати його розвиток.
Безпека проєкту для нас в пріоритеті. Якщо ви виявили вразливість, будь ласка, дивіться нашу політику безпеки в SECURITY.md.
Проєкт розповсюджується під ліцензією GNU GENERAL PUBLIC LICENSE V3.0.
Перегляньте файл LICENSE для отримання додаткової інформації.