https://github.com/denis-bredun/bug-quest
https://github.com/denis-bredun/bug-quest
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/denis-bredun/bug-quest
- Owner: Denis-Bredun
- Created: 2025-02-12T21:35:34.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T22:03:11.000Z (8 months ago)
- Last Synced: 2025-02-12T22:20:14.430Z (8 months ago)
- Language: JavaScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bug Quest
Bug Quest — це веб-платформа, яка дозволяє користувачам створювати, налаштовувати та проходити віртуальні квести з інтерактивними завданнями, використовуючи текст, зображення та відео. Платформа спрямована на інтерактивне навчання, розваги та командоутворення, надаючи користувачам можливість дізнаватися нове, розважатися та працювати разом над цікавими завданнями.
---
## Використаний стек
Цей проект використовує наступні технології та інструменти:
- **React**: бібліотека для побудови користувацьких інтерфейсів на JavaScript.
- **Vite**: сучасний збірник для JavaScript/TypeScript, що забезпечує швидку розробку завдяки використанню ES-модулів.
- **SWC**: компілятор для JavaScript та TypeScript, який є швидшою альтернативою Babel.
- **Node.js**: серверне середовище для виконання JavaScript.
- **Git**: система контролю версій для керування кодом та історією змін.
- **Express**: серверний фреймворк для Node.js, що спрощує розробку веб-додатків.
- **SQLite**: вбудована реляційна база даних для зберігання даних.
- **Tailwind CSS**: утилітарний CSS-фреймворк для швидкого створення стильних та адаптивних інтерфейсів.
- **TypeScript**: надбудова над JavaScript, яка додає типізацію та покращує процес розробки.
---
## Вимоги
Перед тим, як запустити проект, переконайтеся, що на вашому комп'ютері встановлені наступні програми:
- [Node.js](https://nodejs.org/)
- [Git](https://git-scm.com/)
---
## Інструкція з встановлення та запуску
1. **Відкрийте термінал**:
Якщо ви використовуєте **Windows**:
- Натискайте клавіші `Win + R`, введіть `cmd` або `PowerShell`, натисніть Enter.
- Або можете відкрити **Windows Terminal** через меню "Пуск".
Якщо ви використовуєте **MacOS**:
- Відкрийте додаток **Terminal** через Spotlight (Cmd + пробіл, потім введіть "Terminal").
Якщо ви використовуєте **Linux**:
- Відкрийте термінал через комбінацію клавіш `Ctrl + Alt + T` або знайдіть **Terminal** в меню.
2. **Клонуйте репозиторій**:
Відкрийте термінал і введіть наступну команду для клонування проекту на свій комп'ютер:
```bash
git clone https://github.com/chelicksst/Bug-Quest.git
```
Або, якщо ви хочете клонувати за певним шляхом:
```bash
git clone https://github.com/Denis-Bredun/Bug-Quest.git Абсолютний_Шлях_До_Папки
```
4. **Перейдіть до папки проекту**:
Після того, як проект буде клоновано, перейдіть в директорію проекту:
```bash
cd Bug-Quest
```
5. **Встановіть залежності**:
Проект використовує Node.js, тому потрібно встановити всі необхідні залежності. Виконайте команду:
```bash
npm install
```
Також в проєкті при build запускається кілька команд одночасно, тому потрібно встановити окремо concurrently:
```bash
npm install concurrently
```
6. **Запустіть проект**:
Щоб запустити проект локально, використовуйте команду:
```bash
npm run dev
```
Це запустить локальний сервер. Зазвичай, додаток буде доступний за адресою http://localhost:3000 (або за іншою адресою, яку буде вказано в терміналі).
---
## Додаткові сервіси (необов'язкові)
Ці сервіси не є обов'язковими для роботи з проектом, але вони можуть полегшити процес розробки:
- **[GitHub](https://github.com/)** — платформа для хостингу та керування репозиторіями коду. Вона дозволяє вам зберігати, версіювати та співпрацювати над кодом.
- **[WebStorm](https://www.jetbrains.com/webstorm/)** — потужний IDE для розробки на JavaScript, який допомагає з комфортним написанням коду, налагодженням та тестуванням.
- **[SourceTree](https://www.sourcetreeapp.com/)** — графічний інтерфейс для роботи з Git, який дозволяє зручно керувати репозиторіями, комітами та гілками.