🏋️ Онлайн-магазин GYMSHARK

📌 Опис проєкту

GYMSHARK — це онлайн-магазин спортивного одягу та аксесуарів. Проєкт включає фронтенд на React та бекенд на Node.js з використанням Express і PostgreSQL. На даний момент користувачі можуть переглядати доступні товари, а адміністратори мають можливість додавати бренди, типи і товари.

---

🚀 Інструкції з встановлення та запуску

✅ Передумови

Для запуску проєкту необхідно встановити:

• Node.js (v14 або вище)
• PostgreSQL
• Git

🛠️ Кроки для встановлення

1. Клонуйте репозиторій:

   git clone https://github.com/your-username/your-repo-name.git
   cd your-repo-name

2. Встановіть залежності:

   cd backend
   npm install

   cd ../frontend
   npm install

3. Налаштуйте базу даних:
   • Створіть базу даних у PostgreSQL.
   • Створіть .env файл у папці backend і налаштуйте з’єднання:

     DB_NAME=your_db_name
     DB_USER=your_db_user
     DB_PASSWORD=your_db_password
     DB_HOST=localhost
     DB_PORT=5432

4. Запустіть бекенд:

   cd ../backend
   node index.js

5. Запустіть фронтенд:

   cd ../frontend
   npm start

6. Відкрийте браузер та перейдіть за адресою:

   http://localhost:3000
   

---

📂 Структура проєкту

📦 your-repo-name
 ├── backend/        # Бекенд (Node.js, Express, PostgreSQL)
 │   ├── controllers/ # Логіка обробки запитів
 │   ├── models/      # Моделі бази даних
 │   ├── routes/      # Маршрути API
 │   ├── middleware/  # Проміжне ПЗ
 │   ├── .env         # Конфігураційний файл
 │   ├── index.js     # Вхідний файл сервера
 ├── frontend/       # Фронтенд (React)
 │   ├── components/  # Компоненти React
 │   ├── pages/       # Сторінки додатку
 │   ├── store/       # Управління станом (MobX)
 │   ├── http/        # HTTP-запити до API
 │   ├── App.js       # Головний файл додатку
 │   ├── .env         # Конфігураційний файл

---

🛠️ Використані технології

🎨 Frontend:

• ⚛️ React
• 🎨 React Bootstrap
• 🔄 MobX
• 🌍 Axios

⚙️ Backend:

• 🟢 Node.js
• 🚀 Express
• 🗄️ Sequelize
• 🛢️ PostgreSQL

🔧 Інші інструменти:

• 🌱 Git
• 📦 npm
• 🔑 dotenv

---

👨‍💻 Авторство

Проєкт розроблений Мінайленком Віктором Юрійовичем. [email protected]

📜 Ліцензія

Цей проєкт ліцензований за ліцензією MIT. Детальніше у файлі LICENSE.

📖 Документація

📄 Swagger API Documentation

Swagger автоматично доступний після запуску бекенду.

1. Запустіть бекенд за допомогою:

   cd backend
   node index.js

2. Перейдіть за посиланням:

   http://localhost:5000/api-docs
   

   • Документація API доступна за посиланням: Swagger API Docs

📘 Storybook

Storybook для компонентів доступний після запуску:

1. Виконайте наступну команду у папці client:

   npm run storybook

2. Відкрийте браузер і перейдіть за адресою:

   http://localhost:6006
   

• Storybook для компонентів доступний за посиланням: Storybook

📖 Генерована документація

Документація була згенерована за допомогою JSDoc.

1. Відкрийте файл index.html за шляхом: client/docs/index.html - Документація до коду була згенерована за допомогою JSDoc. Вона містить описи функцій, методів та структур даних і доступна за посиланням: JSDoc Documentation

🔒 Privacy Policy

• Політика конфіденційності доступна за посиланням: Privacy Policy

🍪 Cookie Popup

• На сайті реалізовано Cookie Popup, який відповідає вимогам GDPR. Користувач може прийняти або відхилити використання cookies.

---

🛠️ Додаткові інструкції

Перевірка ліцензії

Для перевірки ліцензії використовуйте license-checker:

npx license-checker --json > licenses.json