https://github.com/evrone/bmstu_2024

https://github.com/evrone/bmstu_2024

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/evrone/bmstu_2024
• Owner: evrone
• Archived: true
• Created: 2024-07-02T16:04:43.000Z (almost 2 years ago)
• Default Branch: dev
• Last Pushed: 2024-07-28T12:38:56.000Z (almost 2 years ago)
• Last Synced: 2025-04-05T18:51:39.276Z (about 1 year ago)
• Language: Ruby
• Size: 9.94 MB
• Stars: 4
• Watchers: 5
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Where Are My Likes? 👉👈

Where Are My Likes - это сервис, помогающий пользователям отслеживать и оценивать метрики, а также находить наименее активных подписчиков.

Сервис разрабатывается для использования с профилями пользователей социальной сети VK.

## Как работать с сервисом

Сценарий взаимодействия пользователя следующий:

1. Пользователь аутентифицируется с использованием кнопки OneTap VK ID;

2. Пользователь попадает на дэшборд, в котором видит информацию о своём профиле, подсчитанные общие метрики, список своих постов за год и метрики этих постов, список неактивных друзей;

3. Пользователь может перейти к заинтересовавшему его объекту в сети VK в новой вкладке браузера;

4. Пользователь может запросить обновить его метрики.

Дополнительно в сервисе присутствуют пользователи-администраторы, которые могут получить доступ к "админке" со следующими возможностями:

1. Посмотреть список зарегистрированных пользователей;

2. Посмотреть метрики пользователя и данные, по которым они рассчитаны;

3. Доступ в админку имеют только администраторы, обычные пользователи зайти не могут;

4. Если доступа к админке у пользователя нет, то при попытке в неё войти необходимо вывести ошибку 404.

## Как разрабатывать сервис

Разработка должна вестись в Docker-контейнерах для достижения изоляции среды исполнения и её схожести с средой в проде.

Перечень основных операций с приложением представлен в Makefile, самые полезные из них:

- `make setup` - сборка и конфигурация всех контейнеров, необходимых для работы приложения;

- `make up` - запуск всех контейнеров и приложения;

- `make deps` - обновить lock-файлы и установить зависимости локально (необходимы bundle и yarn);

- `make down` - удаление контейнеров приложения;

- `make clear` - удаление контейнеров/образов/волюмов/сетей и прочего, связанных с приложением;

- `make ash` - запуск терминала в контейнере приложения;

- `make creds` - открыть зашифрованный файл с credentials;

- `make console` - запуск Rails-консоли;

- `make rubocop` - запуск линтера;

- `make rubocop-verbose` - запуск линтера с строгими правилами;

- `make rubocopA` - запуск линтера с автокорректом;

- `make db-migrate` - провести миграции;

- `make db-rollback` - откатить миграцию;

- `make deploy` - выполнить развертывание сервиса.

## Полезные источники

- [12 Factor App](https://12factor.net/) - методология разработки современных веб-приложений;

- [Turbo Rails tutorial](https://www.hotrails.dev/turbo-rails) - гайд, как делать веб-приложения с динамически изменяющимися страничками, без полной перезагрузки, пользуясь всеми возможностями Rails;

- [Stimulus](https://stimulus.hotwired.dev/) - JS-фреймворк в философии Rails;

- [Rails Credentials](https://habr.com/ru/companies/timeweb/articles/543294/) - что такое Credentials в Rails, как ими пользоваться;

- [VK API Reference](https://dev.vk.com/ru/api/overview) - справка по VK API;

- [VK ID Reference](https://id.vk.com/about/business/go/docs/ru/vkid/latest/vk-id/intro/start-page) - справка по VK ID.