Клиентский сервис — {название проекта}

{краткое описание нашего проекта}

Оглавление

1. Архитектура
2. Стек
   • Основной фреймворк
   • Библиотека компонентов
   • Сборка и CI/CD
3. Настройка проекта
   • Требования
   • Установка
4. Полезные ссылки

Архитектура

В проекте используется упрощённая FSD-архитектура:

• src/routes — директория для SvelteKit Router
• src/utils — базовые алгоритмы и функции
• src/services — код для работы с внешним API, хранением глобальных состояний и т.п.
• src/components — компоненты и элементы UI
• src/widgets — самостоятельные виджеты, состоящие из компонентов
• src/features — модули, состоящие из виджетов, выполняющие определённую задачу

Стек

Основной фреймворк

• SvelteKit
• Typescript
• TailwindCSS

Библиотека компонентов

• Shadcn-UI
• Lucida Icons

Сборка и CI/CD

• Vite
• ESLint
• Prettier
• Husky
• Lint-staged

Настройка проекта

Требования

• Node.js
• npm
• git

Установка

# clone the repository
git clone [email protected]:InTeam-Russia/svelte-template-frontend.git
cd svelte-template-frontend

# install yarn (if necessary)
npm i -g yarn

# setup project
yarn
yarn dev

Полезные ссылки

1. Документация Svetle
2. Документация SvelteKit
3. Документация ShadCN-svelte
4. Документация TailwindCSS