Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 49 additions & 83 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,11 @@
<!-- README.md -->

<head>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Satisfy&display=swap" rel="stylesheet">
</head>

<br />
<p align="center">
<img src="./public/banner.jpg" alt="Project Banner" style="border-radius: 12px; box-shadow: 0 8px 24px rgba(0, 0, 0, 0.2);" />
</p>

<h1 align="center" class="title">PETS</h1>
<p align="center" class="subtitle">"Друзі, які завжди поруч"</p>
<h1 align="center">PETS</h1>
<p align="center"><em>"Друзі, які завжди поруч"</em></p>

---

Expand All @@ -36,85 +29,70 @@

---

## Зміст

- [Опис проєкту](#опис-проєкту)
- [Технології](#технології)
- [Функціонал](#функціонал)
- [Скріншоти](#скріншоти)
- [Запуск проєкту](#запуск-проєкту)
- [Автори](#автори)

---
## 🐾 Опис проєкту

## Опис проєкту
**PETS** — це не просто сайт. Це спроба створити екосистему підтримки, де волонтери, притулки та просто небайдужі можуть об'єднатися, щоб допомогти тваринам, які постраждали через війну.

**PETS** — це соціальна платформа, мета якої — об'єднати волонтерів, притулки та небайдужих людей, щоб допомогти постраждалим тваринам під час війни. Це не лише сервіс оголошень, а ціла екосистема взаємодії, підтримки та турботи.
Тут можна знайти нових друзів, прочитати реальні історії, допомогти з усиновленням або просто зробити маленьке добро. Ми віримо, що навіть одна врятована лапа — це вже перемога 🐕❤️

---

## Технології
## 🛠️ Технології

- **React** + **Vite**
- **TypeScript**
- **TailwindCSS**
- **Shadcn UI**
- **React Router DOM**
- **Zod** (валідація)
- **React Hot Toast** (нотифікації)
- **json-server** (локальна БД для розробки)
- **Zod** валідація форм
- **React Hot Toast** нотифікації
- **json-server** — мокова база для розробки

---

## Функціонал
## ⚙️ Функціонал

### 🔐 Аутентифікація

- Реєстрація/авторизація через Email/Password та Google
- Реєстрація та вхід через Email/Password або Google
- Відновлення паролю
- Збереження токена в localStorage
- Збереження токена в LocalStorage

### 👤 Профіль користувача

- Редагування профілю (без ролі)
- Зміна пароля
- Редагування профілю
- Зміна паролю
- Завантаження аватарки

### 🧑‍🤝‍🧑 Ролі

- **Волонтер** — створює оголошення, допомагає тваринам, зв'язується з притулками
- **Притулок** — приймає заявки на усиновлення, створює оголошення про тварин
- **Волонтер** — створює оголошення, допомагає тваринам, спілкується з притулками
- **Притулок** — керує заявками на усиновлення, створює оголошення про тварин

### 📢 Оголошення

- CRUD функціонал: створення, редагування, видалення, перегляд
- Фільтрація за категоріями: Всі / Волонтер / Притулок
- Пошук по назві тварини, притулку або волонтеру
- Додавання в обране
- CRUD (створення, редагування, видалення, перегляд)
- Фільтрація за ролями
- Пошук по імені тварини, волонтеру, притулку
- Додавання в "обране"

### 🐶 Сторінка тварини

- Інформація про тварину
- Відгуки і коментарі
- Детальна інформація
- Відгуки та коментарі

### 🏠 Сторінка притулку

- Інформація про притулок
- Відгуки, коментарі
- Детальна інформація
- Заявка на усиновлення
- Коментарі, рейтинг

### 📰 Блог та новини

- Читання статей і новин
- Створення, редагування, видалення власних матеріалів

### 📄 Сторінка "Про нас"
### 📰 Блог
- Новини, статті, корисні поради
- Можливість додавати власні матеріали

- Інформація про команду, проєкт, партнерів
### ℹ️ Про нас
- Історія проєкту
- Команда
- Партнери

---

## Скріншоти
## 📸 Скріншоти

<p align="center">
<img src="image-2.png" width="60%" />
Expand All @@ -129,49 +107,37 @@

---

## Запуск проєкту
## 🚀 Як запустити проєкт

> Необхідно мати встановлений `pnpm` та `Node.js`
> Потрібні встановлені `pnpm` та `Node.js`

### 1. Встановити pnpm:
### 🔧 Кроки:

```bash
# Встановлюємо pnpm
npm install -g pnpm
```

### 2. Клонувати репозиторій:

```bash
# Клонуємо репозиторій
git clone https://github.com/Vatsonio/Haca2025.git
```

### 3. Перейти в директорію проєкту:

```bash
# Переходимо в папку проєкту
cd Haca2025
```

### 4. Встановити залежності:

```bash
# Встановлюємо залежності
pnpm install
```

### 5. Запустити сервер бази даних (json-server):

```bash
# Запускаємо json-server (локальна БД)
pnpm add -D json-server
pnpm run server
```

### 6. Запустити застосунок:

```bash
# Запускаємо застосунок
pnpm run dev
```

---

## Автори

> Команда, яка дійсно любить тварин і хоче змінити світ. Якщо ви хочете долучитися або маєте ідеї — пишіть!
## 👥 Автори

- [@Vatsonio Ігор](https://github.com/Vatsonio) — Fullstack
- [@WinSoU Даніїл ](https://github.com/bushchakkkkkky) — Тімлід
- [@SamLake Ілья ](https://github.com/sldjfngsldfnsldjfn) — UI/UX
- [@RecognisesPainn Андрій](https://github.com/RecognizesPain) - Ідеї
- [@bushchakk Євген](https://github.com/bushchakkkkkky) - Фронтенд
> Маєш ідеї або хочеш долучитись? Пиши нам — будемо раді!