Шаблон репозиторію для виконання курсової роботи з дисципліни "Бази даних"

Інструкції до використання

В цьому репозиторії знаходиться шаблон для виконання курсової роботи.

Для виконання курсової роботи необхідно зробити fork цього репозіторію, склонувати вже власний репозіторій та розміщувати документацію у відповідних діректоріях ./docs.

У book.toml та README.md необхідно вказати назву проекту, коротку загальну характеристику проекту, контактні дані виконавця, посилання на репо співвиконавців(за необхідністю).

Шаблон публікування курсової роботи підготовлено з використанням mdBook.

Встановлення mdBook

1. Встановіть Rust-тулчейн на свій комп'ютер за допомогою rustup. Уважно слідуйте інструкціям указаним на сайті
2. Встановіть mdBook та допоміжну бібліотеку mdbook-plantuml за допомогою cargo:

   $ cargo install mdbook
   $ cargo install mdbook-plantuml

Щоб опублікувати проект у Github Pages:

• на сторінці github вашого репозиторію переходите в Settings-->Pages, в Sourse обираєте варіант Deploy from branch, в Branch обираєте gh-pages та папку /root та натискаєте Save та повертаєтесь до головної сторінки репозиторію.
• робите коміт у вітку main(master) та пушите його на віддалений репозиторій github, автоматично спрацьовує workflow та починається процес деплою
• Почекайте поки на боковій панелі зʼявиться Deployments та в ньому github-pages(може зайняти і більше хвилинни) та переходите по ньому, там ви побачите url до сторінки вашої документації.

Для відлагодження документації в локальному режимі запускаємо

   $ mdbook serve

Доступ до локально опублікованої версії http://localhost:3000

Додаткова інформація

• Теми проєктів
• Методичні вказівки
• Гайд користувача mdBook
• Документація Markdown

Happy learning! Happy coding!