Витрина решений для акселератора Транспортных инноваций Москвы

Навигация

• Описание проекта
• Стек технологий
• Функционал
• Сборка проекта
• Документация
• Команда
• Лицензия

Описание проекта

Витрина инновационных решений – система, с помощью которой сотрудники организаций транспортного комплекса (потенциальные/функциональные заказчики) смогут ознакомиться с существующими решениями и командами ТИМ и получить доступ к выборке решений под свой запрос.

Стек технологий

• Frontend:
• Backend:
• Bot:
• Proxy:
• Work:

Функционал

• Сотрудник ТИМ
  • Просмотр заявок
  • Просмотр логов
• Владелец проекта
  • Добавление проекта на платформу
  • Подписка на уведомления через Telegram бота или почту
• Руководитель отдела Дептранс
  • Просмотр доступных проектов на платформе
  • Фильтрация и поиск
  • Генерация отчёта в PDF формате по проекту
  • Подписка на уведомления через Telegram бота или почту
  • Добавление проекта в избранное

Сборка проекта

Production

1. Склонируйте данный репозиторий:

git clone https://github.com/Dragonprod/tims.git tims
cd tims

2. Отредактируйте .env.example:

PROXY_ALLOWED_DOMAINS=YOUR_PROXY_ALLOWED_DOMAINS

BACKEND_DEBUG_MODE=Fasle
BACKEND_API_V1_PREFIX=YOUR_BACKEND_API_V1_PREFIX
BACKEND_JWT_SECRET=YOUR_BACKEND_JWT_SECRET

DATABASE_HOST=YOUR_DATABASE_HOST
DATABASE_NAME=YOUR_DATABASE_NAME
DATABASE_USER=YOUR_DATABASE_USER
DATABASE_PASSWORD=YOUR_DATABASE_PASSWORD
DATABASE_PORT=YOUR_DATABASE_PORT

ELASTIC_HOST=YOUR_ELASTIC_HOST
ELASTIC_PORT=YOUR_ELASTIC_PORT

FRONTEND_DEBUG_MODE=Fasle
FRONTEND_PRODUCTION_URL=YOUR_FRONTEND_PRODUCTION_URL

TELEGRAM_BOT_TOKEN=YOUR_TELEGRAM_BOT_TOKEN
TELEGRAM_ADMIN_CHAT_IDS=0,0,0

3. Переименуйте .env.example в .env
4. Запустите проект с помощь Docker Compose:

docker-compose -f docker-compose.production.yml up --build -d

Development

1. Склонируйте данный репозиторий:

git clone https://github.com/Dragonprod/tims.git tims
cd tims

2. Отредактируйте .env.example:

PROXY_ALLOWED_DOMAINS=YOUR_PROXY_ALLOWED_DOMAINS

BACKEND_DEBUG_MODE=Fasle
BACKEND_API_V1_PREFIX=YOUR_BACKEND_API_V1_PREFIX
BACKEND_JWT_SECRET=YOUR_BACKEND_JWT_SECRET

DATABASE_HOST=YOUR_DATABASE_HOST
DATABASE_NAME=YOUR_DATABASE_NAME
DATABASE_USER=YOUR_DATABASE_USER
DATABASE_PASSWORD=YOUR_DATABASE_PASSWORD
DATABASE_PORT=YOUR_DATABASE_PORT

ELASTIC_HOST=YOUR_ELASTIC_HOST
ELASTIC_PORT=YOUR_ELASTIC_PORT

FRONTEND_DEBUG_MODE=Fasle
FRONTEND_PRODUCTION_URL=YOUR_FRONTEND_PRODUCTION_URL

TELEGRAM_BOT_TOKEN=YOUR_TELEGRAM_BOT_TOKEN
TELEGRAM_ADMIN_CHAT_IDS=0,0,0

3. Переименуйте .env.example to .env
4. Установите зависимости Backend части:

cd backend
pip install -r requirements.txt

5. Установите зависимости Frontend части:

cd frontend
npm install

6. Установите зависимости Telegram бота:

cd bot
pip install -r requirements.txt

7. Запустите базу данных и Elastic Search с помощью Docker Compose:

docker-compose -f docker-compose.development.yml up --build -d

8. Запустите Backend часть:

cd backend
python3 main.py

9. Запустите Frontend часть:

cd frontend
npm start

10. Запустите Telegram бота:

cd bot
python3 main.py

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

Frontend запускается по адресу - http://localhost:3001 Backend запускается по адресу - http://localhost:8000

Endpoints

• Swagger - /docs

Тестовые аккаунты

• Сотрудник ТИМС

  • Логин - [email protected]
  • Пароль - admin

• Клиент ТИМС

  • Логин - [email protected]
  • Пароль - client

• Владелец проекта

  • Логин - [email protected]
  • Пароль - startup

Команда

• Васечкин Артём - FullStack разработчик
• Шевченко Максим – Backend разработчик
• Коробов Максим – Frontend разработчик

Лицезия

• MIT