Skip to content

Проектная работа для middle.praktikum.yandex. Игра.

Notifications You must be signed in to change notification settings

LevanovaElena/teamwork_4

 
 

Repository files navigation

Демо 06.12.2023

Демо 17.01.2024

Как запускать?

  1. Убедитесь что у вас установлен node и docker
  2. Выполните команду yarn bootstrap - это обязательный шаг, без него ничего работать не будет :)
  3. Выполните команду yarn dev
  4. Выполните команду yarn dev --scope=client чтобы запустить только клиент
  5. Выполните команду yarn dev --scope=server чтобы запустить только server

Как запускать с ssr?

  1. Зайдите в папку client
  2. Выполните команду yarn link
  3. Зайдите в папку server
  4. Выполните команду yarn link "client"
  5. Выполните команду yarn dev

Как собирать с ssr?

  1. Зайдите в папку client
  2. Выполните команду yarn link
  3. Выполните команду yarn build:ssr
  4. Выполните команду yarn build
  5. Зайдите в папку server
  6. Выполните команду yarn link "client"
  7. Выполните команду yarn build

Как собирать запустить docker?

  1. docker-compose build
  2. docker-compose up
  3. открыть http://localhost:3000

Анализ безопасности

Авторизация закрывает доступ к данным. Ручки на сервере закрыты. Данные, вводимые пользователем валидируются и проверяются.

Как добавить зависимости?

В этом проекте используется monorepo на основе lerna

Чтобы добавить зависимость для клиента yarn lerna add {your_dep} --scope client

Для сервера yarn lerna add {your_dep} --scope server

И для клиента и для сервера yarn lerna add {your_dep}

Если вы хотите добавить dev зависимость, проделайте то же самое, но с флагом dev yarn lerna add {your_dep} --dev --scope server

Тесты

Для клиента используется react-testing-library

yarn test

Линтинг

yarn lint

Форматирование prettier

yarn format

Production build

yarn build

И чтобы посмотреть что получилось

yarn preview --scope client yarn preview --scope server

Хуки

В проекте используется lefthook Если очень-очень нужно пропустить проверки, используйте --no-verify (но не злоупотребляйте :)

Ой, ничего не работает :(

Откройте issue, я приду :)

Автодеплой статики на vercel

Зарегистрируйте аккаунт на vercel Следуйте инструкции В качестве root directory укажите packages/client

Все ваши PR будут автоматически деплоиться на vercel. URL вам предоставит деплоящий бот

Production окружение в докере

Перед первым запуском выполните node init.js

docker compose up - запустит три сервиса

  1. nginx, раздающий клиентскую статику (client)
  2. node, ваш сервер (server)
  3. postgres, вашу базу данных (postgres)

Если вам понадобится только один сервис, просто уточните какой в команде docker compose up {sevice_name}, например docker compose up server

About

Проектная работа для middle.praktikum.yandex. Игра.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 97.5%
  • CSS 1.5%
  • Other 1.0%