docs: add multilingual README
This commit is contained in:
lizerk
parent
b4de4aa449
commit
8799b23443
86
README.de.md
Normal file
86
README.de.md
Normal file
@ -0,0 +1,86 @@
|
||||
**Sprache:** [English](README.md) | [Русский](README.ru.md) | [Deutsch](README.de.md) | [Español](README.es.md)
|
||||
|
||||
# EUSRR
|
||||
|
||||
EUSRR ist ein internes Enterprise-Service-Portal, entwickelt mit Django, Django REST Framework, Next.js, PostgreSQL, Redis, Celery, WebSockets, LDAP-Integration, Benachrichtigungen, Dokumenten-Workflows, Beschaffungsprozessen, Planung und Employee-Self-Service-Modulen.
|
||||
|
||||
Das Projekt zeigt Full-Stack-Produktentwicklung: Backend-Architektur, REST APIs, rollenbasierte Zugriffskontrolle, asynchrone Aufgaben, Echtzeit-Updates, Frontend-Struktur, Tests, deployment-orientierte Konfiguration und produktionsnahe Betriebsdokumentation.
|
||||
|
||||
## Kernmodule
|
||||
|
||||
- Mitarbeiterverzeichnis, Profile, Abteilungen, Rollen und LDAP-Synchronisierung.
|
||||
- Anträge und Freigabe-Workflows mit Statusverfolgung und Benachrichtigungen.
|
||||
- Beschaffungsprozesse, Freigaberouten, Artikelverwaltung und Lieferstatus.
|
||||
- Dokumente, Dateien, Kommentare und interne Zusammenarbeit.
|
||||
- Kalender- und Planungsfunktionen mit gemeinsamen Ereignissen.
|
||||
- Echtzeitkommunikation, WebSocket-Benachrichtigungen und Chat-Workflows.
|
||||
- LogStorm-Integration für operative Anwesenheitsanalysen.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- Backend: Python, Django, Django REST Framework, Channels, Celery, Redis, PostgreSQL.
|
||||
- Frontend: Next.js, React, TypeScript, Tailwind CSS, Recharts, React Table.
|
||||
- Integrationen: LDAP, Web Push, Telegram/Synology-style notification adapters, LogStorm API.
|
||||
- Testing: pytest für Backend-Tests, Node test runner und ESLint für Frontend-Checks.
|
||||
- Deployment: Docker-orientierte Einstellungen, umgebungsbasierte Konfiguration, Nginx-ready service layout.
|
||||
|
||||
## Repository-Struktur
|
||||
|
||||
```text
|
||||
backend/ Django backend, APIs, Celery tasks, migrations, tests, docs
|
||||
frontend/ Next.js frontend application
|
||||
docs/ Architecture notes, implementation reports, guides, diagnostics
|
||||
```
|
||||
|
||||
## Lokales Setup
|
||||
|
||||
Backend:
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
python -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
cp ../.env.example ../.env
|
||||
python manage.py migrate
|
||||
python manage.py runserver
|
||||
```
|
||||
|
||||
Frontend:
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
cp .env.example .env.local
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Das Frontend ist unter `http://localhost:3000` erreichbar. `NEXT_PUBLIC_BACKEND_URL` muss auf das Backend zeigen.
|
||||
|
||||
## Tests
|
||||
|
||||
Backend:
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
pytest
|
||||
```
|
||||
|
||||
Frontend:
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm test
|
||||
npm run lint
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Security Notes
|
||||
|
||||
Diese öffentliche Version ist als Portfolio-Snapshot vorbereitet. Environment-Dateien, lokale Datenbanken, Media Uploads, Zertifikate, private keys, generierte Builds und deployment-spezifische Artefakte sind aus der Versionskontrolle ausgeschlossen.
|
||||
|
||||
Alle Zugangsdaten müssen über Environment Variables bereitgestellt werden. Beispiel-Dateien enthalten nur Platzhalter und dürfen nicht als Production Secrets verwendet werden.
|
||||
|
||||
## Demo Data
|
||||
|
||||
Das Repository enthält keine Produktionsdaten. Unternehmensspezifische Werte sollten vor dem Betrieb außerhalb der ursprünglichen Umgebung durch lokale Demo-Daten ersetzt werden.
|
||||
86
README.es.md
Normal file
86
README.es.md
Normal file
@ -0,0 +1,86 @@
|
||||
**Idioma:** [English](README.md) | [Русский](README.ru.md) | [Deutsch](README.de.md) | [Español](README.es.md)
|
||||
|
||||
# EUSRR
|
||||
|
||||
EUSRR es un portal interno de servicios empresariales construido con Django, Django REST Framework, Next.js, PostgreSQL, Redis, Celery, WebSockets, integración LDAP, notificaciones, flujos de documentos, flujos de compras, planificación y módulos de autoservicio para empleados.
|
||||
|
||||
El proyecto demuestra desarrollo full-stack de producto: arquitectura backend, REST APIs, control de acceso basado en roles, tareas asíncronas, actualizaciones en tiempo real, estructura frontend, pruebas, configuración orientada al despliegue y documentación operativa de estilo productivo.
|
||||
|
||||
## Módulos principales
|
||||
|
||||
- Directorio de empleados, perfiles, departamentos, roles y sincronización LDAP.
|
||||
- Solicitudes y approval workflows con seguimiento de estado y notificaciones.
|
||||
- Flujos de compras, approval routes, gestión de items y seguimiento de entrega.
|
||||
- Documentos, archivos, comentarios y colaboración interna.
|
||||
- Calendario y scheduling con eventos compartidos.
|
||||
- Comunicaciones en tiempo real, WebSocket notifications y chat-oriented workflows.
|
||||
- Integración con LogStorm para analítica operativa de asistencia.
|
||||
|
||||
## Stack técnico
|
||||
|
||||
- Backend: Python, Django, Django REST Framework, Channels, Celery, Redis, PostgreSQL.
|
||||
- Frontend: Next.js, React, TypeScript, Tailwind CSS, Recharts, React Table.
|
||||
- Integraciones: LDAP, Web Push, Telegram/Synology-style notification adapters, LogStorm API.
|
||||
- Testing: pytest para backend tests, Node test runner y ESLint para frontend checks.
|
||||
- Deployment: configuración orientada a Docker, environment-based configuration, Nginx-ready service layout.
|
||||
|
||||
## Estructura del repositorio
|
||||
|
||||
```text
|
||||
backend/ Django backend, APIs, Celery tasks, migrations, tests, docs
|
||||
frontend/ Next.js frontend application
|
||||
docs/ Architecture notes, implementation reports, guides, diagnostics
|
||||
```
|
||||
|
||||
## Configuración local
|
||||
|
||||
Backend:
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
python -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
cp ../.env.example ../.env
|
||||
python manage.py migrate
|
||||
python manage.py runserver
|
||||
```
|
||||
|
||||
Frontend:
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
cp .env.example .env.local
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Abre el frontend en `http://localhost:3000` y configura `NEXT_PUBLIC_BACKEND_URL` para apuntar al backend.
|
||||
|
||||
## Tests
|
||||
|
||||
Backend:
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
pytest
|
||||
```
|
||||
|
||||
Frontend:
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm test
|
||||
npm run lint
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Security Notes
|
||||
|
||||
Esta versión pública está preparada como portfolio snapshot. Los archivos de entorno, bases de datos locales, media uploads, certificados, private keys, builds generados y artefactos específicos de deployment están excluidos del control de versiones.
|
||||
|
||||
Todas las credenciales deben suministrarse mediante environment variables. Los archivos de ejemplo contienen solo placeholders y no deben utilizarse como production secrets.
|
||||
|
||||
## Demo Data
|
||||
|
||||
El repositorio no contiene production data. Cualquier valor especifico de empresa debe reemplazarse con datos demo locales antes de ejecutar el proyecto fuera de su entorno original.
|
||||
@ -1,3 +1,5 @@
|
||||
**Language:** [English](README.md) | [Русский](README.ru.md) | [Deutsch](README.de.md) | [Español](README.es.md)
|
||||
|
||||
# EUSRR
|
||||
|
||||
EUSRR is an internal enterprise service portal built with Django, Django REST Framework, Next.js, PostgreSQL, Redis, Celery, WebSockets, LDAP integration, notifications, document workflows, procurement workflows, scheduling, and employee self-service modules.
|
||||
|
||||
86
README.ru.md
Normal file
86
README.ru.md
Normal file
@ -0,0 +1,86 @@
|
||||
**Язык:** [English](README.md) | [Русский](README.ru.md) | [Deutsch](README.de.md) | [Español](README.es.md)
|
||||
|
||||
# EUSRR
|
||||
|
||||
EUSRR - внутренний корпоративный сервисный портал на Django, Django REST Framework, Next.js, PostgreSQL, Redis, Celery и WebSockets. Проект включает LDAP-интеграцию, уведомления, документооборот, закупочные процессы, календарное планирование и модули самообслуживания сотрудников.
|
||||
|
||||
Проект демонстрирует full-stack разработку продукта: backend-архитектуру, REST API, ролевую модель доступа, асинхронные задачи, обновления в реальном времени, структуру frontend-приложения, тестирование, конфигурацию для деплоя и production-style документацию.
|
||||
|
||||
## Основные модули
|
||||
|
||||
- Справочник сотрудников, профили, отделы, роли и LDAP-синхронизация.
|
||||
- Заявки и маршруты согласования со статусами и уведомлениями.
|
||||
- Закупочные процессы, маршруты утверждения, учет позиций и отслеживание поставок.
|
||||
- Документы, файлы, комментарии и внутреннее взаимодействие.
|
||||
- Календарь и планирование с общими событиями.
|
||||
- Коммуникации в реальном времени, WebSocket-уведомления и chat-oriented workflows.
|
||||
- Интеграция с LogStorm для аналитики посещаемости.
|
||||
|
||||
## Стек
|
||||
|
||||
- Backend: Python, Django, Django REST Framework, Channels, Celery, Redis, PostgreSQL.
|
||||
- Frontend: Next.js, React, TypeScript, Tailwind CSS, Recharts, React Table.
|
||||
- Integrations: LDAP, Web Push, Telegram/Synology-style notification adapters, LogStorm API.
|
||||
- Testing: pytest для backend-тестов, Node test runner и ESLint для frontend-проверок.
|
||||
- Deployment: Docker-oriented settings, environment-based configuration, Nginx-ready service layout.
|
||||
|
||||
## Структура репозитория
|
||||
|
||||
```text
|
||||
backend/ Django backend, APIs, Celery tasks, migrations, tests, docs
|
||||
frontend/ Next.js frontend application
|
||||
docs/ Architecture notes, implementation reports, guides, diagnostics
|
||||
```
|
||||
|
||||
## Локальный запуск
|
||||
|
||||
Backend:
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
python -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
cp ../.env.example ../.env
|
||||
python manage.py migrate
|
||||
python manage.py runserver
|
||||
```
|
||||
|
||||
Frontend:
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
cp .env.example .env.local
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Frontend открывается на `http://localhost:3000`. Переменная `NEXT_PUBLIC_BACKEND_URL` должна указывать на backend.
|
||||
|
||||
## Проверка
|
||||
|
||||
Backend:
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
pytest
|
||||
```
|
||||
|
||||
Frontend:
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm test
|
||||
npm run lint
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Security Notes
|
||||
|
||||
Публичная версия подготовлена как portfolio snapshot. Env-файлы, локальные базы данных, media uploads, certificates, private keys, generated builds и deployment-specific artifacts исключены из version control.
|
||||
|
||||
Все credentials должны передаваться через environment variables. Example-файлы содержат только placeholders и не должны использоваться как production secrets.
|
||||
|
||||
## Demo Data
|
||||
|
||||
Репозиторий не содержит production data. Любые company-specific values нужно заменить локальными demo data перед запуском вне исходной среды.
|
||||
Loading…
x
Reference in New Issue
Block a user