Проект Indey

Проект Indey — набор базовых инструментов для инди-предпринимателей, с ограниченным бюджетом для разработки и внедрения цифровых продуктов. Презентация продукта(-ов), обработка заказов и поддержка клиентов — основная цель Indey.

Проект состоит из трёх приложений (Indey.Landing, Indey.CRM, Indey.API) для обеспечения заказов на продукта(-ов), сопровождения продукта(-ов) и работы с клиентами.

Приложения

Indey.Landing

Технологический стек

1. Движок MPA (multi page application) на основе генератора статических сайтов 11ty.

Indey.CRM

Технологический стек

1. Движок SPA (Single page application) на основе фреймворка Vue.JS.

Indey.API

Технологический стек

1. Движок на базе фреймворка ExpressJS.

Разработка

Репозиторий работает на системе контроля версий Git. Для начала работы необходимо склонировать репозиторий с помощью команды:

git clone git@github.com:fine-solutions/indey.git

В репозитории используется система ветвления GitHub flow. Перед внесением изменений необходимо переключится на основную ветку main, обновить её и после этого создать новую ветку, в которой уже можно вносить изменения:

git switch main
git fetch
git rebase
git branch <branch-name>
git switch <branch-name>

Система именования веток

Для правильного именования веток используется следующий шаблон (на основе статьи):

<type>/<user>-[<issue>-]<content>

Возможные значения для <type>:

• build — изменения, касающиеся процесса сборки(npm, vite);
• chore — изменения, не касающиеся кода напрямую, то что не увидит конечный пользователь(установка/удаление зависимостей, настройка проекта/инструментов);
• ci — изменения, касающиеся CI/CD;
• docs — изменения, касающиеся документации;
• feature — новая функциональность;
• bugfix — работа с ошибками;
• performance — изменения, касающиеся улучшения производительности приложений;
• refactor — изменения по улучшению существующего кода;
• revert — для отмены коммита;
• style — изменения, относящиеся к стилизации, форматированию;
• test — добавление недостающих тестов или корректирование уже существующих тестов.

Для поля <user> необходимо указать имя пользователя на GitHub.

Поле <issue> является опциональным и используется для случая, когда ветка соответствует issue в репозитории на GitHub.

Поле <content> используется для краткого описания решенной задачи и не может быть больше 30 символов.

Система создания сообщений для коммитов

Для создания коммитов используется следующий формат сообщения:

<type>: <short description>

Поле <type> соответствует полю для веток из раздела выше.

Поле <short description> содержит краткое описание изменений. Суммарно всё сообщение коммита не может быть больше 50 символов.