docs: Обновление README
This commit is contained in:
@@ -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
|
||||||
|
|
||||||
|
## Локальный запуск проекта
|
||||||
|
|
||||||
|
Проект состоит из двух частей: легковесного бэкенда (PocketBase) и фронтенда (Angular 22).
|
||||||
|
|
||||||
|
### 1. Запуск бэкенда (PocketBase)
|
||||||
|
|
||||||
|
В репозитории уже лежат файлы структуры базы данных в папке `pb_migrations`. При запуске PocketBase автоматически накатит нужные миграции.
|
||||||
|
|
||||||
|
1. Скачайте исполняемый файл **PocketBase** для вашей ОС с [официального сайта](https://pocketbase.io/docs/) (или разверните через Docker).
|
||||||
|
2. Поместите бинарник `pocketbase` в корневую папку этого проекта (на один уровень с папкой `pb_migrations`).
|
||||||
|
3. Запустите сервер:
|
||||||
```bash
|
```bash
|
||||||
ng serve
|
./pocketbase serve
|
||||||
```
|
```
|
||||||
|
*PocketBase запустится на `http://127.0.0.1:8090` и автоматически применит схему БД.*
|
||||||
|
|
||||||
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.
|
### 2. Настройка и запуск фронтенда (Angular)
|
||||||
|
|
||||||
## Code scaffolding
|
|
||||||
|
|
||||||
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
|
|
||||||
|
|
||||||
|
1. Установите зависимости проекта:
|
||||||
```bash
|
```bash
|
||||||
ng generate component component-name
|
pnpm install
|
||||||
```
|
```
|
||||||
|
2. Убедитесь, что адрес API указан верно. Конфигурация для локальной разработки находится в файле `src/environments/environment.development.ts`:
|
||||||
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
|
```typescript
|
||||||
|
export const environment = {
|
||||||
|
production: false,
|
||||||
|
apiUrl: 'http://127.0.0.1:8090'
|
||||||
|
};
|
||||||
|
```
|
||||||
|
3. Запустите dev-сервер:
|
||||||
```bash
|
```bash
|
||||||
ng generate --help
|
pnpm start
|
||||||
```
|
```
|
||||||
|
4. Откройте приложение в браузере по адресу `http://localhost:4200`.
|
||||||
## 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.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user