tasyakh / praktika-2023

яндекс метрика и топвизор, создание кабинета для сео специалиста

Яндекс метрика и топвизор 2023

Технологии

бэкенд - nest.js, документация https://nestjs.com

фронтенд - vue.js (3-я версия), документация https://vuejs.org

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

1. скачать nodejs https://nodejs.org/en

зайти в cmd и проверить что установлен, написать в терминале

2. Скачать vs code https://code.visualstudio.com
3. Открыть vs code и нажать клонировать репозиторий, ввести эту https://github.com/TasyaKh/Praktika-2023.git ссылку во всплывающее окно, сохраните в любую папку этот проект

4. Перейти на свою ветку разработки (там должна гореть ваша ветка во вкладке Source Control)

5. Итак, вы в своем пустом проекте, что дальше? Вам надо сохранить последние изменения с main ветки в свою

6. Слева наверху есть вкладка Terminal > new Terminal, в терминале ввести команду

cd .\client\

далее (нужно скачать нужные нам библиотеки)

npm i

Запуск проекта

Клиент

в папке client 6-го шага настройки написать (вы должны быть в папке client проекта)

npm run dev

результат, по ссылке в терминале сможете посмотреть наш сайт

Сервер

во 2-м терминале перейти в папку

cd .\server\

написать в терминале

npm i -g @nestjs/cli

npm i

запустить сервер

npm run start:dev

на сервере обязательно должен быть config.ts след. вида

export const TOPVISOR_API_URL = {
  baseUrl: {url топвизора},
  userID: {id юзера в топвизоре},
  authToken: { авторизационый токен}
};


export const YANDEX_API_URL = {
  baseUrl: {url яндекса},
  oAuthToken: { авторизационый токен}
};

БД

1. скачать pgAdmin 4, создать бд, далее зайти в

cd .\server\

2. создать или обновить файл .env, который имеет след. вид.

DB_NAME={имя бд}
DB_USER={пользователь}
DB_PASSWORD={пароль}
DB_HOST=localhost
DB_PORT=5432

3. Далее необходимо сделать миграцию бд, чтобы создалось нужные таблицы. Найти файл package.json и запустить скрипт migrations:run, в терминале или при наведении на него
4. Если миграфии успешно прошли запустить сервер и написать в браузере, например, след путь

GET http://localhost:3000/api/general/update-db

это необходимо, чтобы обновить бд, стянуть проекты и данные для дашбордов для старта

Заметка:

для взаимодейтсвия с бд на серверной части используется typeorm https://typeorm.io сущности в бд сохраняются через миграции, сами сущности омечены как entity.ts, про миграции читать на сайте nest js

в бд могут быть некоторые недочеты или использоваться лишние поля, требуется доработать

Справка

может вы заметили, что некоторые файлы подсвечиваются красным, путь не найден, нужно скачать расширение в vs code во вкладке extensions "TypeScript Vue Plugin"

Советую пошариться в плагинах и настроить по себя, плагины у меня:

1. vscode-icons
2. IntelliSense for CSS class

Документация

api сервера задокументированы в swagger, зайти http://localhost:3000/documentation на запущенном сервере

Подробное описание см. wiki в гитхабе этого проекта

Скрины