https://github.com/code-418-dpr/kntista

Проект для автоматизации нужд профбюро ИКНТ
https://github.com/code-418-dpr/kntista

docker kntista microservices monorepo

Last synced: about 1 year ago
JSON representation

Проект для автоматизации нужд профбюро ИКНТ

• Host: GitHub
• URL: https://github.com/code-418-dpr/kntista
• Owner: code-418-dpr
• License: mit
• Created: 2025-03-25T12:52:48.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-25T17:10:47.000Z (about 1 year ago)
• Last Synced: 2025-03-25T18:25:25.628Z (about 1 year ago)
• Topics: docker, kntista, microservices, monorepo
• Homepage:
• Size: 2.93 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# KNTista

[![license](https://img.shields.io/github/license/code-418-dpr/KNTista)](https://opensource.org/licenses/MIT)

[![release](https://img.shields.io/github/v/release/code-418-dpr/KNTista?include_prereleases)](https://github.com/code-418-dpr/KNTista/releases)

[![downloads](https://img.shields.io/github/downloads/code-418-dpr/KNTista/total)](https://github.com/code-418-dpr/KNTista/releases)

[![code size](https://img.shields.io/github/languages/code-size/code-418-dpr/KNTista.svg)](https://github.com/code-418-dpr/KNTista)

Проект для автоматизации

нужд [профбюро ИКНТ](https://vk.com/iknt_donntu?search_track_code=0420b647WLLSflc78zrg5LRY4zMF19lgtvcEt0MKSGkWyLJHZPUORjS99-wIghu51TqCTkmNgTLes1XiAW9NVxDMpzgS&from=search)

## Особенности реализации

- [x] микросервисная архитектура

- [x] единая среда развёртывания

- [x] интегрирован CI/CD

- [x] веб-приложение с поддержкой технологии PWA

- [x] полностью рабочий функционал отслеживания активности на факультете и составления отчётов о ней

- [ ] Telegram-бот поддерживает часть клиентского функционала веб-приложения

## Архитектура

Проект состоит из микросервисов, предназначенных для развёртывания в Docker:

- [фронтенд](https://github.com/code-418-dpr/KNTista-frontend)

- [бэкенд](https://github.com/code-418-dpr/KNTista-api)

- Telegram-бот...

## Установка

> [!NOTE]

> Мы отказались от использования `git submodules` и `git subtree` из-за периодически возникающей путаницы при

> отслеживании изменений в монорепозиториях. Данный репозиторий представляет собой единую точку для работы с проектом,

> лишённую этих недостатков.

0. Клонируйте репозиторий и перейдите в его папку.

1. Клонируйте репозитории сервисов, входящих в состав проекта по SSH (рекомендуется):

```shell

git clone git@github.com:code-418-dpr/KNTista-frontend.git services/frontend

git clone git@github.com:code-418-dpr/KNTista-api.git services/api

```

или по HTTPS:

```shell

git clone https://github.com/code-418-dpr/KNTista-frontend.git services/frontend

git clone https://github.com/code-418-dpr/KNTista-backend.git services/api

```

После этого вы можете вносить изменения в каждый из сервисов по-отдельности (в соответствии с инструкциями, описанными в

соответствующих README).

## Запуск

0. Установите проект по инструкции выше.

1. Создайте файл `.env` на основе [.env.template](.env.template) и настройте все описанные там параметры.

2. Установите Docker.

3. Ознакомьтесь с инструкциями к сервисам проекта. Некоторые из них могут требовать дополнительной конфигурации (

   например, применение миграций к БД)

4. Теперь запускать проект можно командой:

```shell

docker compose up -d --build

```