Skip to content

Alex0xfffff/text_simplifier

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Объясни как пятилетнему

Учебный веб-сервис: вставьте сложный текст — получите объяснение простым языком (как для ребёнка или неспециалиста).

Стек

  • Frontend: React, TypeScript, Vite, CSS Modules
  • Backend: Node.js, Express, TypeScript
  • Структура: две папки client и server, запуск одной командой из корня

Установка и запуск

1. Установить зависимости

Из корня проекта:

npm run install:all

Или по отдельности:

cd server && npm install
cd ../client && npm install

2. Настроить GigaChat API (Sberbank)

В проекте используется модель GigaChat от Сбера. Учётные данные берутся из личного кабинета GigaChat API.

  1. Скопируйте пример конфигурации в папке server:

    cd server && copy .env.example .env

    (В Linux/macOS: cp .env.example .env)

  2. Откройте server/.env и укажите:

    • GIGACHAT_CLIENT_ID — Client ID из личного кабинета GigaChat API.
    • GIGACHAT_CLIENT_SECRET — Client Secret (секретный ключ). Опционально: GIGACHAT_MODEL (по умолчанию GigaChat), GIGACHAT_SCOPE (GIGACHAT_API_PERS для физлиц, GIGACHAT_API_CORP для юрлиц).
  3. Сертификат Минцифры (при ошибке SSL): для доступа к GigaChat с Windows/Node нужен корневой сертификат. Скачайте russian_trusted_root_ca_pem.crt, сохраните на диск и в server/.env добавьте:

    GIGACHAT_CA_FILE=C:\путь\к\russian_trusted_root_ca_pem.crt
    

3. Запустить приложение

Из корня проекта:

npm run dev

Будут запущены:

Откройте в браузере http://localhost:5173.

Либо запускайте по отдельности в двух терминалах:

npm run dev:server   # только backend
npm run dev:client   # только frontend

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

explain-like-five/
├── client/          # React + Vite
│   └── src/
│       ├── components/
│       ├── api/
│       └── types/
├── server/          # Express + TypeScript
│   └── src/
│       ├── routes/
│       ├── services/
│       └── types/
├── .env.example
├── package.json
└── README.md

Где что настраивать

  • GigaChat (Client ID и Client Secret): в server/.env (см. server/.env.example).
  • Порт backend: по умолчанию 3002; при необходимости измените в server/src/index.ts или через переменную PORT в server/.env.
  • Прокси к API: в client/vite.config.ts настроен proxy с /api на http://localhost:3002, чтобы фронт ходил на тот же origin.

Это учебный проект; ключи и секреты храните только в .env, не в коде.


About

Учебный веб-сервис: вставьте сложный текст — получите объяснение простым языком (как для ребёнка или неспециалиста).

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages