dmitlenko / studentflow

StudentFlow

StudentFlow - це кросплатформена онлайн-дошка, спеціально розроблена для студентів, щоб вони могли знаходити та розміщувати оголошення, а також спілкуватися між собою.

Вимоги до системи

Серверні вимоги:

• Операційна система: Linux, Windows або macOS.
• Середовище виконання: Docker.

Клієнтські вимоги:

• Веб-браузер: Сучасний веб-браузер, такий як Google Chrome, Mozilla Firefox, Safari або Microsoft Edge.
• Підтримка JavaScript: Браузер повинен підтримувати виконання JavaScript.

Мобільні вимоги:

• Операційна система: Android або iOS.
• Версія ОС: Мінімум Android 6.0 або iOS 12.

Інші вимоги:

• Інтернет-з'єднання: Для користування онлайн дошкою "StudentFlow" потрібне активне підключення до Інтернету.

Конфігурація

Для налаштування параметрів проєкту "StudentFlow" можна використовувати файл .env. Цей файл є текстовим файлом, який зберігає конфігураційні змінні середовища.

Щоб налаштувати проєкт, створіть файл з назвою .env у кореневій директорії проекту та додайте в нього рядки наступного формату:

# Налаштування фреймворку Django
DJANGO_SECRET_KEY='<секретний ключ Django>'
DJANGO_ALLOWED_HOSTS=<домен сайту> # наприклад 'example.com'
DJANGO_CSRF_TRUSTED_ORIGINS=<домен сайту з протоколом> # наприклад 'https://example.com'

# Налаштування кеш-системи Redis
REDIS_HOST=<хост кеш-системи> # 127.0.0.1 за замовчуванням
REDIS_PORT=<порт кеш-системи> # 6379 за замовчуванням

# Налаштування бази даних PostgreSQL
POSTGRES_DB=<назва БД>
POSTGRES_USER=<користувач БД>
POSTGRES_PASSWORD=<пароль користувача БД>
POSTGRES_HOST=<хост БД> # 127.0.0.1 за замовчуванням
POSTGRES_PORT=<порт БД> # 5432 за замовчуванням

Щоб отримати секретний ключ Django, необхідно виконанти наступну команду:

python3 -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'

В її результаті на екран буде виведено секретний ключ, який потім можна вставити в файл .env.

Інструкція першого запуску

Дуже легко і швидко. Для цього потрібно виконати одну команду в терміналі:

docker compose up

Після цього можна буде перейти по домену сайту, який вказано в файлі .env.

Ліцензія

Проект "StudentFlow" розповсюджується під ліцензією Apache 2.0.

Ліцензія Apache, Версія 2.0

Дозволяється безкоштовно використовувати, копіювати, змінювати та розповсюджувати цей програмний продукт згідно з умовами ліцензії Apache, Версія 2.0.

Детальнішу інформацію дивіться у файлі LICENSE, який супроводжує цей програмний продукт.

ПРОГРАМНИЙ ПРОДУКТ НАДАЄТЬСЯ "ЯК Є", БЕЗ БУДЬ-ЯКИХ ВИСЛОВЛЕНИХ АБО ПІДХОДЯЩИХ ГАРАНТІЙ, ВКЛЮЧАЮЧИ ГАРАНТІЇ ПРИДАТНОСТІ ДЛЯ ПРОДАЖУ, ВІДПОВІДНОСТІ ДО ПЕВНОЇ МЕТИ ТА НЕПОРУШЕННОСТІ. АВТОРИ АБО ВЛАСНИКИ АВТОРСЬКИХ ПРАВ НЕ НЕСУТЬ ВІДПОВІДАЛЬНОСТІ ЗА БУДЬ-ЯКІ ПРЕТЕНЗІЇ, ЗБИТКИ ЧИ ІНШУ ВІДПОВІДАЛЬНІСТЬ, НЕЗАЛЕЖНО ВІД ДОГОВОРУ, ПОРУШЕННЯ АВТОРСЬКИХ ПРАВ АБО ІНШИХ ДІЙ, ЩО ВИНИКАЮТЬ З ЧИ В СУДОВОМУ ПОРЯДКУ ЗВ'ЯЗКУ З ПРОГРАМНИМ ПРОДУКТОМ.

Автори

Автор: Денис Мітленко

Електронна пошта: [email protected]

Заклад: Дніпровський фаховий коледж зварювання та електроніки імені Є.О. Патона

Група: ПЗ-19-1/9

Рік: 2023