diff --git a/web/README.md b/web/README.md index 9395075..a899ebe 100644 --- a/web/README.md +++ b/web/README.md @@ -1,44 +1,28 @@ -# sv +# EvoBGP WebUI -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +SvelteKit-приложение панели управления EvoBGP. Запуск — [docs/quickstart.md](../docs/quickstart.md). -Это веб-интерфейс **EvoBGP**. Запуск вместе с API, CORS и портами — в [../docs/quickstart.md](../docs/quickstart.md); доступ и ключи — [../docs/access.md](../docs/access.md). +## UI-архитектура -## Creating a project +| Путь | Назначение | +|------|------------| +| `src/lib/ui/core/` | shadcn-svelte (только через `npx shadcn-svelte@latest add … -y -o`) | +| `src/lib/ui/app/` | Layout, PageHeader, toast (`notify`) | +| `src/lib/ui/patterns/` | FormField, AppDataTable, ConfirmDialog, EmptyState | +| `src/lib/components/ui/` | Re-export на `ui/core` (совместимость) | -If you're seeing this, you've probably already done this step. Congrats! +Токены темы: `src/routes/layout.css`. Справочник: `src/lib/ui/app/tokens.md`. -```sh -# create a new project -npx sv create my-app -``` - -To recreate this project with the same configuration: - -```sh -# recreate this project -npx sv@0.14.0 create --template minimal --types ts --add tailwindcss="plugins:none" sveltekit-adapter="adapter:static" prettier --no-download-check --install npm web -``` - -## Developing - -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +## Разработка ```sh +npm install npm run dev - -# or start the server and open the app in a new browser tab -npm run dev -- --open +npm run check ``` -## Building - -To create a production version of your app: +Добавление компонентов shadcn (из каталога `web/`): ```sh -npm run build +npx shadcn-svelte@latest add -y -o ``` - -You can preview the production build with `npm run preview`. - -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.