https://github.com/notacat1/binder
BINDER - Business card of a construction and repair company
https://github.com/notacat1/binder
react react-slick scss slick-carousel typescript
Last synced: 18 days ago
JSON representation
BINDER - Business card of a construction and repair company
- Host: GitHub
- URL: https://github.com/notacat1/binder
- Owner: NotACat1
- Created: 2024-12-22T13:55:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-30T02:19:41.000Z (over 1 year ago)
- Last Synced: 2025-05-18T13:50:06.266Z (11 months ago)
- Topics: react, react-slick, scss, slick-carousel, typescript
- Language: TypeScript
- Homepage: https://notacat1.github.io/BINDER/
- Size: 4.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# BINDER - Визитка строительно-ремонтной компании 🛠️
Добро пожаловать в **BINDER** – проект сайта-визитки для строительно-ремонтной компании. Этот сайт создан для демонстрации профессионального подхода, удобства взаимодействия с клиентами и эстетичного дизайна. 🚀
---
## 🌟 Основные функции проекта
- **Современный дизайн:** сайт адаптирован под разные устройства.
- **Форма обратной связи:** реализована с использованием сервиса [Formspree](https://formspree.io).
- **Слайдер изображений:** создан с помощью библиотек `react-slick` и `slick-carousel`.
- **Секретность данных:** конфиденциальные данные (например, ссылки Formspree) спрятаны в `.env` файл.
---
## 🛠️ Используемые технологии
| Технология | Описание |
|---------------|-------------------------------------------------------------------------------------------|
| React | Библиотека для построения пользовательского интерфейса. |
| TypeScript | Язык программирования для надежной и масштабируемой разработки. |
| SCSS | Расширение CSS с переменными, вложенностью и другими удобствами. |
| Bootstrap | CSS-фреймворк для быстрого создания адаптивного дизайна. |
| Craco | Упрощает конфигурацию Create React App без необходимости `eject`. |
| Eslint | Инструмент для проверки качества и стилистики кода. |
| Prettier | Форматирование кода для единого стиля. |
| Husky | Настройка git-хуков для автоматической проверки кода. |
| Commitlint | Проверяет сообщения коммитов на соответствие заданным правилам. |
---
## ⚙️ Скрипты проекта
| Скрипт | Описание |
|----------------|------------------------------------------------------------------------------------------|
| `lint` | Запуск проверки качества кода с помощью ESLint. |
| `format` | Форматирование кода с помощью Prettier. |
| `prepare` | Установка git-хуков Husky. |
| `start` | Локальный запуск проекта с помощью Craco. |
| `build` | Сборка проекта для продакшена. |
| `test` | Запуск тестов. |
| `predeploy` | Предварительная сборка перед деплоем. |
| `deploy` | Размещение проекта на GitHub Pages. |
---
## 🔑 Пример `.env` файла
Для корректной работы проекта убедитесь, что у вас есть файл `.env` с соответствующими данными:
```env
REACT_APP_FORMSPREE_URL=https://formspree.io/f/your_form_id
```
---
## 📦 Установка и запуск
1. Склонируйте репозиторий:
```bash
git clone https://github.com/NotACat1/BINDER.git
cd BINDER
```
2. Установите зависимости:
```bash
npm install
```
3. Запустите проект:
```bash
npm start
```
---
## 📸 Скриншоты
---
## 🤝 Вклад в проект
Буду рад вашим идеям и улучшениям! Для предложения изменений создавайте **Issue** или отправляйте **Pull Request**.
---
⭐ Спасибо за интерес к проекту! Надеюсь, сайт вдохновит вас на новые идеи и проекты!