sms new

.github/workflows/docs-publish.yml

@@ -0,0 +1,23 @@
+name: Build and publish docs
+run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  Publish-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+      - run: npm install
+      - run: npm run docs:build
+      - name: Publish build to gh-pages
+        uses: peaceiris/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/.vuepress/dist

.vs/VSWorkspaceState.json

@@ -0,0 +1,7 @@
+{
+  "ExpandedNodes": [
+    ""
+  ],
+  "SelectedNode": "\\D:\\Microsoft Visual Studio\\Repos\\IM-22_lab_and_course_works",
+  "PreviewInSolutionExplorer": false
+}

README.md

@@ -3,6 +3,8 @@
 
 ## Як використовувати
 
+Посилання на документацію: https://strivingtoadoniss.github.io/IM-22_lab_and_course_works/
+
 В цьому репозиторії знаходиться шаблон для виконання лабораторних робіт.
 
 Для виконання лабораторних робіт необхідно зробити ```fork``` цього репозіторію, склонувати вже власний репозіторій та розміщувати документацію у відповідних діректоріях ```./docs```.

docs/.vuepress/config.js

@@ -15,7 +15,7 @@ module.exports = {
     }]
   ],
   port: 3030,
-  base: '/edu_db_labs/',
+  base: '/IM-22_lab_and_course_works/',
   theme: 'cool',
   // dest: 'dist',
   head: [

docs/README.md

@@ -3,14 +3,13 @@ home: true
 actionText: Розпочати →
 actionLink: /intro/
 
-footer: "ECL 2.0 Licensed | Copyright © [YYYY] [Your Name]"
+footer: "ECL 2.0 Licensed | Copyright © [2023] [Oleksand Horovyi]"
 ---
 
 
 **Виконав(-ла):** 
 
-*студент(-ка) 2-го курсу, групи (шифр групи)*<span padding-right:5em></span> **[ім’я ПРІЗВИЩЕ] [Посилання email, tg, fb]**
-
+*студент 2-го курсу, групи ІМ-22*<span padding-right:5em></span> **Горовий Олександр** [Telegram](https://t.me/GigaWaltuh)
 
 **Керівник**
 

docs/conclusion/README.md

@@ -1,12 +1,19 @@
 # Висновки
 
-У висновках наводять оцінку отриманих результатів, можливі галузі його використання. Висновки повинні містити в собі коротку узагальнену оцінку результатів розробки, у
-тому числі і з погляду на їх технічно-економічну ефективність. Необхідно порівняти
-отримані результати усіх характеристик об’єкта проєктування із завданням і з основними показниками сучасних аналогічних об’єктів.
+## Узагальнена оцінка результатів:
 
-Необхідно вказати яке нове технічне рішення покладене в основу проєкту і у чому її
-переваги, що нового було запропоновано самим студентом. 
+Розроблене APІ виглядає добре структурованим та функціональним. Створена архітектура дозволяє підвщити швидкість роботи із базою даних, а також має приємний інтерфейс.
+
+## Технічно-економічна ефективність:
+
+Використання FastAPI дозволяє швидко розробляти API з високою продуктивністю, що може сприяти ефективності розробки. Асинхронний підхід може полегшити роботу в умовах великої кількості одночасних запитів.
+
+## Порівняння з аналогічними рішеннями:
+
+Порівняно з іншими аналогічними рішеннями, наведеними вище у роботі, наше рішення може забезпечити конкурентні переваги в швидкодії та зручності розробки. Однак, результати також можуть залежати від конкретних вимог та обсягу роботи.
+
+## Рекомендації:
+
+На основі розглянутих результатів, рекомендується зберігати високу якість коду та забезпечувати його документацією. Важливо також враховувати специфіку завдань та обсягів роботи при використанні цього API.
 
-На базі отриманих висновків можуть надаватися рекомендації по використанню розробки. Вони повинні
-мати конкретний характер і бути цілком підтверджені проєктом.
 

docs/design/README.md

@@ -1,7 +1,190 @@
 # Проєктування бази даних
 
-В рамках проекту розробляється: 
-- модель бізнес-об'єктів 
-- ER-модель
-- реляційна схема
+## Модель бізнес-об'єктів
 
+@startuml
+
+entity User
+entity User.firstname
+User.firstname -u-* User
+entity User.lastname
+User.lastname -u-* User
+entity User.nickname
+User.nickname -u-* User
+entity User.email
+User.email -u-* User
+entity User.password
+User.password -u-* User
+
+entity Permission
+entity Permission.name
+Permission.name -d-* Permission
+
+entity Right
+entity Right.name
+Right.name -u-* Right
+
+entity Grant
+
+entity Role
+entity Role.name
+Role.name -u-* Role
+entity Role.description
+Role.description -d-* Role
+
+entity Access
+
+entity Request
+entity Request.target
+Request.target -u-* Request
+entity Request.type
+Request.type -u-* Request
+entity Request.date
+Request.date -u-* Request
+
+entity Search
+
+entity Filter
+entity Filter.keyword
+Filter.keyword -d-* Filter
+entity Filter.country
+Filter.country -d-* Filter
+entity Filter.fileFormat
+Filter.fileFormat -l-* Filter
+
+entity File
+entity File.name
+File.name -d-* File
+entity File.description
+File.description -d-* File
+entity File.uploadDate
+File.uploadDate -d-* File
+entity File.lastEditDate
+File.lastEditDate -d-* File
+entity File.format
+File.format -d-* File
+entity File.hasVisualization
+File.hasVisualization -u-* File
+entity File.authorId
+File.authorId -l-* File
+entity File.country
+File.country -r-* File
+
+User "0,*" -l- "1,1" Role
+User "1,1" -r- "0,*" Request
+
+Access "0,*" -d- "1,1" Role
+Access "0,*" -u- "1,1" File
+
+Grant "0,*" -l- "1,1" Right
+Grant "0,*" -r- "1,1" Role
+
+Right "1,1" -l- "0,*" Permission
+
+Search "0,*" -d- "1,1" Request
+Search "0,*" -u- "1,1" File
+
+Filter "0,*" -l- "1,1" Request
+
+@enduml
+
+## ER-модель
+
+@startuml
+
+package ProfileManagement {
+entity User <<ENTITY>> {
+    id: UUID
+    nickname: TEXT
+    firstname: TEXT
+    lastname: TEXT
+    email: TEXT
+    password: TEXT
+}
+}
+
+package AccessPolicy {
+entity Permission <<ENTITY>> {
+    id: NUMBER
+    name: TEXT
+}
+
+entity Right <<ENTITY>> {
+    id: NUMBER
+    name: TEXT
+}
+
+entity Grant
+
+enum Role <<ENUMERATION>> #yellow {
+    id: NUMBER
+    name: TEXT
+    description: TEXT
+}
+
+object Guest #white
+Guest .u.> Role :instanceOf
+object RegisteredUser #white
+RegisteredUser .u.> Role :instanceOf
+object Editor #white
+Editor .u.> Role :instanceOf
+object Administrator #white
+Administrator .u.> Role :instanceOf
+
+entity Access
+}
+
+package DataReceiving {
+entity Request <<ENTITY>> {
+    id: NUMBER
+    target: TEXT
+    type: TEXT
+    date: DATETIME
+}
+
+entity Search
+
+entity Filter <<ENTITY>> {
+    id: NUMBER
+    keyword: TEXT
+    country: TEXT
+    fileFormat: TEXT
+}
+}
+
+package DataManipulation {
+entity File <<ENTITY>> {
+    id: UUID
+    name: TEXT
+    description: TEXT
+    uploadDate: DATETIME
+    lastEditDate: DATETIME
+    format: TEXT
+    hasVisualization: BOOLEAN
+    authorId: UUID
+    country: TEXT
+}
+}
+
+User "0,*" --> "1,1" Role
+
+Permission "0,*" -l-> "1,1" Right
+
+Grant "0,*" -r-> "1,1" Right
+Grant "0,*" --> "1,1" Role
+
+Access "0,*" -d-> "1,1" Role
+Access "0,*" -u-> "1,1" File
+
+Request "0,*" --> "1,1" User
+
+Search "0,*" --> "1,1" Request
+Search "0,*" --> "1,1" File 
+
+Filter "0,*" --> "1,1" Request
+
+@enduml
+
+## Реляційна схема
+
+![relational-schema](./images/relational-schema.png)

docs/intro/README.md

@@ -1,12 +1,5 @@
 # Вступ
 
-У вступі описується мета роботи і розглядається поставлене завдання з позиції її
-актуальності, значення її розв’язання для тієї предметної області, до якої відноситься
-тема бакалаврського проєкту. 
+Мета цього проекту - створення інноваційної системи управління та візуалізації відкритих даних. У сучасному світі обсяг відкритих даних надзвичайно великий, і, незважаючи на існуючі системи, що працюють з ними, існують значні недоліки, на виправлення яких спрямований наш проєкт.
 
-Коротко характеризується сучасний рівень розв’язання
-даного завдання і взаємозв’язок з іншими проєктами по цій тематиці. 
-
-Наводяться
-основні технічні характеристики розробки й очікуваний технічно-економічний ефект
-від її реалізації. 
+Багато існуючих систем забезпечують легкий доступ до даних, але надають несамодостатні засоби для їхньої ефективної візуалізації, тоді як інші можуть бути надто складними для використання. Наш проєкт намагатиметься створити систему, яка задовольняє ключові потреби користувачів, поєднуючи легкість доступу до даних з ефективною та інтуїтивно зрозумілою їхньою візуалізацією. Ми впевнені, що наш підхід принесе нові можливості у сфері управління та аналізу відкритих даних.