forked from StrivingToAdoniss/IM-22_lab_and_course_works
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
674bb43
commit 58fa9b0
Showing
1 changed file
with
9 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,71 +1,18 @@ | ||
# Система управління відкритими даними | ||
|
||
# Шаблон репозиторію для виконання лабораторних робіт з дисципліни "Організація баз даних" | ||
## Опис проєкту | ||
|
||
## Як використовувати | ||
Цей репозиторій містить систему управління відкритими даними, розроблену в рамках лабораторних робіт з дисципліни "Бази даних". Система дозволяє зручно зберігати, обробляти та надавати доступ до відкритих даних. | ||
|
||
Посилання на документацію: https://strivingtoadoniss.github.io/IM-22_lab_and_course_works/ | ||
## RESTful API | ||
|
||
В цьому репозиторії знаходиться шаблон для виконання лабораторних робіт. | ||
Реалізовано RESTful API для взаємодії з системою управління відкритими даними. API дозволяє отримувати, додавати, оновлювати та видаляти дані за допомогою стандартних HTTP-запитів. | ||
|
||
Для виконання лабораторних робіт необхідно зробити ```fork``` цього репозіторію, склонувати вже власний репозіторій та розміщувати документацію у відповідних діректоріях ```./docs```. | ||
### Документація | ||
|
||
В цьому файлі необхідно вказати тему лабораторних робіт (назву проекту). Коротку загальну характеристику | ||
проекту, контактні дані виконавця, посилання на репо співвиконавців (за необхідністю). | ||
Докладну інформацію про проект, включаючи інструкції з використання, можна знайти в [документації проекту](https://hlibpavlyk.github.io/IM-22_lab_and_course_works/). | ||
|
||
## Контактна інформація | ||
|
||
Шаблон публікування підготовлено з використанням [VuePress](https://vuepress.vuejs.org/), та стартера | ||
[FriendlyUser/vuepress-theme-cool-starter](https://github.com/FriendlyUser/vuepress-theme-cool-starter). | ||
- **Виконавець:** [Гліб Павлик](https://t.me/hlibpavlyk) | ||
|
||
Щоб опублікувати проект у Github Pages, налаштовуємо Github Pages (гілка ```gh-pages```), змінюємо файл ```./publish.sh``` | ||
|
||
```sh | ||
|
||
#!/usr/bin/env sh | ||
|
||
# abort on errors | ||
set -e | ||
|
||
# build | ||
npm run docs:build | ||
|
||
# navigate into the build output directory | ||
cd docs/.vuepress/dist | ||
|
||
# if you are deploying to a custom domain | ||
# echo 'www.example.com' > CNAME | ||
|
||
git init | ||
git add -A | ||
git commit -m 'deploy' | ||
|
||
# if you are deploying to https://<USERNAME>.github.io | ||
# git push -f git@github.com:boldak/<USERNAME>.github.io.git master | ||
|
||
# if you are deploying to https://<USERNAME>.github.io/<REPO> | ||
git push -f https://github.com/<USERNAME>/dis-edu.git master:gh-pages | ||
|
||
cd - | ||
|
||
``` | ||
|
||
Потім запускаємо | ||
|
||
```bash | ||
npm run publish | ||
``` | ||
|
||
Для відлагодження документації в локальному режимі запускаємо | ||
|
||
```bash | ||
npm run docs:dev | ||
``` | ||
|
||
Доступ до локально опублікованої версії [http://localhost:3030](http://localhost:3030) | ||
|
||
|
||
## Додаткова інформація | ||
|
||
- [Теми проєктів](./guidelines/themes.md) | ||
- [Методичні вказівки](./guidelines/guidelines.md) | ||
|
||
***Happy learning! Happy coding!*** |