From 52112082971f46df96cca036bb0bcebfccad5775 Mon Sep 17 00:00:00 2001 From: kamask Date: Fri, 11 Sep 2026 17:03:55 +0300 Subject: [PATCH] =?UTF-8?q?docs:=20=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=BB?= =?UTF-8?q?=D0=B5=D0=BD=D0=B8=D0=B5=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 84 +++++++++++++++++++++++-------------------------------- 1 file changed, 35 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index a5321c3..6b720e3 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,45 @@ -# Kskcrmspa +# KSK CRM SPA -This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 22.1.5. +Пет-проект: CRM-система для управления заказами частного мастера. +Проект создаётся в практических целях для глубинного освоения **Angular 22** и современной экосистемы фронтенд-разработки. -## Development server +## Стек технологий -To start a local development server, run: +* **Frontend:** Angular 22 +* **Backend / Database:** PocketBase +* **Package Manager:** pnpm -```bash -ng serve -``` +## Локальный запуск проекта -Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files. +Проект состоит из двух частей: легковесного бэкенда (PocketBase) и фронтенда (Angular 22). -## Code scaffolding +### 1. Запуск бэкенда (PocketBase) -Angular CLI includes powerful code scaffolding tools. To generate a new component, run: +В репозитории уже лежат файлы структуры базы данных в папке `pb_migrations`. При запуске PocketBase автоматически накатит нужные миграции. -```bash -ng generate component component-name -``` +1. Скачайте исполняемый файл **PocketBase** для вашей ОС с [официального сайта](https://pocketbase.io/docs/) (или разверните через Docker). +2. Поместите бинарник `pocketbase` в корневую папку этого проекта (на один уровень с папкой `pb_migrations`). +3. Запустите сервер: + ```bash + ./pocketbase serve + ``` + *PocketBase запустится на `http://127.0.0.1:8090` и автоматически применит схему БД.* -For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run: +### 2. Настройка и запуск фронтенда (Angular) -```bash -ng generate --help -``` - -## Building - -To build the project run: - -```bash -ng build -``` - -This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed. - -## Running unit tests - -To execute unit tests with the [Vitest](https://vitest.dev/) test runner, use the following command: - -```bash -ng test -``` - -## Running end-to-end tests - -For end-to-end (e2e) testing, run: - -```bash -ng e2e -``` - -Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs. - -## Additional Resources - -For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page. +1. Установите зависимости проекта: + ```bash + pnpm install + ``` +2. Убедитесь, что адрес API указан верно. Конфигурация для локальной разработки находится в файле `src/environments/environment.development.ts`: + ```typescript + export const environment = { + production: false, + apiUrl: 'http://127.0.0.1:8090' + }; + ``` +3. Запустите dev-сервер: + ```bash + pnpm start + ``` +4. Откройте приложение в браузере по адресу `http://localhost:4200`.