Update README with project description
This commit is contained in:
@@ -1,53 +1,68 @@
|
||||
# React + TypeScript + Vite
|
||||
# ReSekai
|
||||
|
||||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
|
||||
**ReSekai** — интерактивная платформа для создания и прохождения текстовых ролевых историй с AI-персонажами.
|
||||
|
||||
Currently, two official plugins are available:
|
||||
🌐 **Демо:** [resekai.draug.me](https://resekai.draug.me)
|
||||
|
||||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
|
||||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
|
||||
## Возможности
|
||||
|
||||
## React Compiler
|
||||
- 📖 **Создание историй** — описывайте сеттинг, персонажей и стартовую сцену
|
||||
- 🎭 **AI-персонажи** — уникальные характеры с настраиваемыми личностями
|
||||
- 💬 **Интерактивный чат** — общайтесь с персонажами в реальном времени (streaming)
|
||||
- 🎨 **Настройка креативности** — выбирайте температуру генерации (0.9–1.05)
|
||||
- 💾 **Сохранение прогресса** — истории хранятся локально в браузере
|
||||
- 📱 **Адаптивный дизайн** — работает на десктопе и мобильных устройствах
|
||||
|
||||
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
|
||||
## Технологии
|
||||
|
||||
## Expanding the ESLint configuration
|
||||
### Frontend
|
||||
- React 18 + TypeScript
|
||||
- Vite
|
||||
- CSS (без фреймворков)
|
||||
|
||||
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
|
||||
### Backend
|
||||
- Express.js (прокси-сервер)
|
||||
- DeepSeek API (модель deepseek-chat V3)
|
||||
|
||||
```js
|
||||
export default defineConfig([
|
||||
globalIgnores(['dist']),
|
||||
{
|
||||
files: ['**/*.{ts,tsx}'],
|
||||
extends: [
|
||||
// Other configs...
|
||||
## Установка
|
||||
|
||||
// Remove tseslint.configs.recommended and replace with this
|
||||
tseslint.configs.recommendedTypeChecked,
|
||||
// Alternatively, use this for stricter rules
|
||||
tseslint.configs.strictTypeChecked,
|
||||
// Optionally, add this for stylistic rules
|
||||
tseslint.configs.stylisticTypeChecked,
|
||||
```bash
|
||||
# Клонировать репозиторий
|
||||
git clone https://git.draug.me/draug/resekai.git
|
||||
cd resekai
|
||||
|
||||
// Other configs...
|
||||
],
|
||||
languageOptions: {
|
||||
parserOptions: {
|
||||
project: ['./tsconfig.node.json', './tsconfig.app.json'],
|
||||
tsconfigRootDir: import.meta.dirname,
|
||||
},
|
||||
// other options...
|
||||
},
|
||||
},
|
||||
])
|
||||
# Установить зависимости
|
||||
npm install
|
||||
cd server && npm install && cd ..
|
||||
|
||||
# Создать .env файл
|
||||
echo "VITE_DEEPSEEK_API_KEY=your_api_key" > .env
|
||||
|
||||
# Запустить в режиме разработки
|
||||
npm run dev # Frontend (порт 5173)
|
||||
cd server && node index.js # Backend (порт 3001)
|
||||
```
|
||||
|
||||
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
|
||||
## Структура проекта
|
||||
|
||||
```js
|
||||
// eslint.config.js
|
||||
import reactX from 'eslint-plugin-react-x'
|
||||
```
|
||||
src/
|
||||
├── components/ # Header, Footer
|
||||
├── contexts/ # AuthContext
|
||||
├── pages/ # Страницы приложения
|
||||
│ ├── StoriesPage # Список историй
|
||||
│ ├── CreateStoryPage # Создание/редактирование
|
||||
│ ├── GamePage # Игровой чат
|
||||
│ └── CharactersPage # Управление персонажами
|
||||
├── services/ # API, DeepSeek, Storage
|
||||
└── types/ # TypeScript типы
|
||||
server/
|
||||
└── index.js # Express прокси для DeepSeek API
|
||||
```
|
||||
|
||||
## Лицензия
|
||||
|
||||
MIT
|
||||
import reactDom from 'eslint-plugin-react-dom'
|
||||
|
||||
export default defineConfig([
|
||||
|
||||
Reference in New Issue
Block a user