Skip to content

Commit

Permalink
+docs +pnpm +bun
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniil-Oberlev committed Aug 20, 2024
1 parent 44784c9 commit 25ef2dc
Show file tree
Hide file tree
Showing 35 changed files with 14,759 additions and 1,026 deletions.
10 changes: 9 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,12 @@ indent_size = 2

# CSS files
[*.css]
indent_size = 2
indent_size = 2

# JSON files
[*.json]
indent_size = 2

# YAML files
[*.yml, *.yaml]
indent_size = 2
2 changes: 1 addition & 1 deletion .env
Original file line number Diff line number Diff line change
@@ -1 +1 @@
REACT_APP_API_URL=http://localhost:4444
AUTH_API_URL=http://localhost:4444
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AUTH_API_URL=
5 changes: 1 addition & 4 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
{
"extends": [
"next/core-web-vitals",
"plugin:storybook/recommended"
]
"extends": ["next/core-web-vitals", "plugin:storybook/recommended"]
}
49 changes: 49 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Основные владельцы всего репозитория 🛠️

## Владельцы репозитория

- **@Daniil-Oberlev** - Daniil Oberlev

- **Роль**: Главный разработчик, архитектор решений
- **Ответственности**:
- Ответственен за общий обзор кода и архитектуры проекта.
- Управление релизами и внедрением новых фич.
- Согласование крупных изменений и улучшений.
- Координация всех аспектов разработки и обеспечения целостности проекта.

- **@AlexxxeyKuleshov** - Alexey Kuleshov
- **Роль**: Старший разработчик, инженер по качеству
- **Ответственности**:
- Контроль качества кода и тестирование.
- Решение проблем с производительностью и безопасностью.
- Разработка и поддержка компонентов, включая верстку и стили.
- Обеспечение соблюдения стандартов и поддержка документации.

## Контактные данные 📧

- **@Daniil-Oberlev**:

- **Email**: denioberlev@gmail.com
- **Telegram**: [Daniil Oberlev](https://t.me/OberlevD)

- **@AlexxxeyKuleshov**:
- **Email**: al2ex2ey8@gmail.com
- **Telegram**: [Alexey Kuleshov](https://t.me/krxwrt)

## Задачи и области ответственности ⚙️

- **@Daniil-Oberlev**:

- Проектирование архитектуры и принятие решений по техническим вопросам.
- Ведение и утверждение планов релизов.
- Взаимодействие с внешними заинтересованными сторонами.

- **@AlexxxeyKuleshov**:
- Обеспечение соблюдения стандартов качества.
- Разработка и поддержка пользовательских интерфейсов, включая верстку и стили.
- Проведение тестирования и обеспечение непрерывной интеграции.
- Поддержка и улучшение внутренней документации.

---

**Обратите внимание:** В случае возникновения вопросов по проекту, первым делом обращайтесь к указанным владельцам.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Сообщение об ошибке 🐞

## Описание ошибки 🚨

Пожалуйста, предоставьте подробное описание ошибки, с которой вы столкнулись. Укажите, что именно пошло не так и как это влияет на работу.

## Шаги для воспроизведения 🔍

Опишите последовательность шагов, чтобы воспроизвести ошибку:

1. Шаг 1
2. Шаг 2
3. Шаг 3

## Ожидаемое поведение 🎯

Опишите, что вы ожидали увидеть вместо ошибки. Это поможет понять, как должно работать приложение или функционал.

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

Если возможно, прикрепите скриншоты, чтобы помочь в понимании проблемы. Они могут значительно облегчить диагностику.

## Окружение 🌍

Укажите информацию о вашем окружении:

- **Операционная система**: [например, Windows 10, macOS 11.2]
- **Браузер/Инструмент**: [например, Chrome 89.0, Node.js 14.17.0]
- **Версия проекта**: [например, v1.2.3]

## Дополнительная информация ℹ️

Добавьте любую дополнительную информацию, которая может быть полезна для воспроизведения ошибки или её исправления. Это может включать логи, конфигурации или специфичные детали.

---

**Спасибо за ваш вклад в проект ITB - IT Exchange!** 🚀
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Запрос на улучшение 🌟

## Описание улучшения 🚀

Пожалуйста, опишите предложение по улучшению, включая:

- **Что именно** вы предлагаете?
- **Как это будет работать**?
- **Как это повлияет** на проект?

### Примеры

Добавьте примеры, если это поможет лучше понять ваше предложение.

## Почему это нужно 🤔

Объясните причины, по которым это улучшение важно:

- **Проблема**: Что именно вы хотите решить?
- **Преимущества**: Какое преимущество это даст проекту или пользователям?
- **Воздействие**: Как это улучшение повлияет на функциональность или пользовательский опыт?

## Как это должно работать 🔧

Опишите, как вы видите реализацию улучшения:

- **Функциональные требования**: Какие ключевые функции должны быть реализованы?
- **Ожидаемое поведение**: Как должен работать этот функционал?
- **Технические детали**: Есть ли какие-то особенности, которые необходимо учесть?

### Примеры реализации

Если есть примеры, как это может быть реализовано, добавьте их сюда.

## Дополнительная информация 📚

Добавьте любую дополнительную информацию, которая может помочь в реализации улучшения:

- **Связанные запросы**: Ссылки на другие связанные запросы или обсуждения.
- **Дизайн и идеи**: Идеи по дизайну или ссылками на макеты.
- **Документация**: Ссылки на документацию или руководства, которые могут быть полезны.

---

**Спасибо за ваш вклад в проект ITB - IT Exchange!** 🙌
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/general_inquiry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Общий запрос или вопрос ❓

## Описание запроса 📝

Пожалуйста, опишите ваш запрос или вопрос:

- **Что именно** вам нужно узнать или обсудить?
- **Какая информация** вам нужна для решения вашего вопроса?

## Контекст 🌐

Предоставьте контекст для вашего запроса:

- **Связь с проектом**: Как ваш запрос или вопрос связан с проектом?
- **Текущие задачи**: Как это влияет на текущие задачи или цели?

## Ожидания 🎯

Укажите, что вы ожидаете от ответа:

- **Тип ответа**: Какие ответы или решения вы хотите получить?
- **Формат ответа**: В каком формате вам удобнее получить информацию?

## Дополнительная информация 📚

Добавьте любую дополнительную информацию, которая может быть полезна для понимания вашего запроса:

- **Связанные документы**: Ссылки на документы или файлы, которые могут быть полезны.
- **Предыдущие обсуждения**: Ссылки на обсуждения или запросы, связанные с вашим вопросом.

---

**Спасибо за ваш вклад в проект ITB - IT Exchange!** 🙌
49 changes: 49 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Pull Request

## Описание изменений ✨

Пожалуйста, опишите в этом разделе, что было изменено, добавлено или исправлено. Укажите, почему эти изменения важны и как они улучшают проект.

**Тип изменения:**

- [ ] Функционал
- [ ] Исправление ошибки
- [ ] Улучшение документации
- [ ] Другое (пожалуйста, укажите):

**Связанные задачи/проблемы:**

- Укажите ссылки на задачи или проблемы, которые решаются этим PR (например, #123, #456).

## Как протестировать 🧪

Опишите шаги, которые нужно выполнить для проверки ваших изменений. Убедитесь, что вы включили все необходимые команды для тестирования и возможные сценарии использования.

1. Шаг 1
2. Шаг 2
3. Шаг 3

**Результат тестирования:**

- Опишите, как вы проверили изменения и какие результаты были получены.

## Примечания и замечания 📝

Добавьте любые дополнительные замечания, рекомендации или примечания, которые могут помочь рецензентам понять ваши изменения или контекст.

## Список изменений 🗂️

Убедитесь, что ваши изменения включены в PR и соответствуют требованиям:

- [ ] Все тесты пройдены успешно.
- [ ] Код соответствует [Руководству по Стилю Кодирования](../STYLE_GUIDE.md).
- [ ] Обновлена документация при необходимости.
- [ ] Проверены и исправлены возможные конфликты с основной веткой.

## Вопросы и обсуждения ❓

Если у вас есть вопросы или требуется дополнительное обсуждение по вашему PR, напишите их здесь.

---

**Спасибо за ваш вклад в проект ITB - IT Exchange!** 🚀
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
22.2.0
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Changelog

Все заметные изменения в этом проекте будут документироваться в этом файле.

## [Не выпущено] 🚧

### Добавлено ✨

- Инициализация проекта. 🚀
- Установлены основные зависимости. 📦
- Создана базовая структура репозитория. 🏗️

### Изменения 🔧

- Подготовка к первому релизу. 🛠️

### Устраненные ошибки 🐛

- На данный момент не зарегистрированы. ❓

### Прочее 📝

- Проект находится на стадии разработки. Ожидайте обновлений в ближайшее время. ⏳

---

**Обновлено:** 20.08.2024
70 changes: 70 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Кодекс Поведения 🌟

## Наши Обязанности 🤝

Мы, как участники, контрибьюторы и лидеры нашего сообщества, обязуемся обеспечить участие в нашем проекте без преследований и дискриминации. Мы стремимся создать открытое, приветливое, разнообразное, инклюзивное и здоровое сообщество для всех, независимо от возраста, размеров тела, инвалидностей, этнической принадлежности, половых характеристик, гендерной идентичности и выражения, уровня опыта, образования, социо-экономического статуса, национальности, личного внешнего вида, расы, религии, сексуальной идентичности или ориентации. 🌈

## Наши Стандарты ✅

Мы поощряем следующее поведение:

- 🌟 Проявление эмпатии и доброты к другим
- 🗣️ Уважение к различным мнениям и опыту
- ✨ Дача и конструктивное принятие обратной связи
- 🙌 Принятие ответственности за свои ошибки, извинение перед пострадавшими и извлечение уроков
- 🌍 Ориентирование на благо всего сообщества

Неприемлемое поведение включает:

- 🚫 Использование сексуализированного языка или изображений, а также сексуальные домогательства
- 😠 Троллинг, оскорбления, уничижительные комментарии, личные или политические атаки
- 🛑 Публичные или частные преследования
- 🔒 Публикация личной информации без разрешения
- 📵 Связь в частном порядке без согласия через установленные механизмы сообщества
- ⚠️ Другие действия, которые считаются неприемлемыми в профессиональной среде

## Ответственность за Применение 🛡️

Лидеры сообщества отвечают за соблюдение наших стандартов поведения и применяют справедливые меры в ответ на любое неприемлемое поведение. Они могут удалять, редактировать или отклонять комментарии, коммиты, код, правки в вики, проблемы и другие вклады, не соответствующие Кодексу Поведения, и объяснять свои действия по модерации, когда это уместно.

## Область Применения 🌐

Этот Кодекс Поведения применяется во всех аспектах нашего сообщества, включая официальные представления нашего проекта в публичных пространствах. Примеры представления сообщества включают использование официального адреса электронной почты, публикации через официальные социальные медиа-аккаунты и участие в мероприятиях онлайн или офлайн.

## Процедура Применения 📣

Случаи нарушения Кодекса Поведения можно сообщить ответственному лицу по адресу <opensource@github.com>. Все жалобы будут рассмотрены и расследованы оперативно и справедливо. Лидеры сообщества обязаны уважать конфиденциальность и безопасность лиц, сообщивших о нарушениях.

## Руководство по Применению 📋

Лидеры сообщества следуют следующим руководствам при определении последствий за нарушения Кодекса Поведения:

### 1. Исправление 📝

**Воздействие**: Неприемлемое поведение, которое требует личного вмешательства.

**Последствия**: Личное предупреждение с разъяснением нарушения и его неприемлемости. Могут потребоваться публичные извинения.

### 2. Предупреждение 🚨

**Воздействие**: Однократное или повторное нарушение стандартов сообщества.

**Последствия**: Формальное предупреждение с запретом на взаимодействие с пострадавшими на определённый период. Нарушение условий может привести к временной или постоянной блокировке.

### 3. Временная Блокировка ⏳

**Воздействие**: Серьезное или повторное нарушение стандартов.

**Последствия**: Временная блокировка от взаимодействия или общения с сообществом. Нарушение условий может привести к постоянной блокировке.

### 4. Постоянная Блокировка 🚫

**Воздействие**: Продолжительное и серьёзное нарушение стандартов сообщества.

**Последствия**: Постоянная блокировка от любого публичного взаимодействия в сообществе.

## Источники 📚

Этот Кодекс Поведения основан на [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html), версия 2.0, и вдохновлён [кодексом поведения Mozilla](https://github.com/mozilla/diversity).

Часто задаваемые вопросы о Кодексе Поведения можно найти в [FAQ](https://www.contributor-covenant.org/faq). Переводы доступны на [веб-сайте](https://www.contributor-covenant.org/translations).
Loading

0 comments on commit 25ef2dc

Please sign in to comment.