Skip to content

Latest commit

 

History

History
188 lines (143 loc) · 8.11 KB

README.md

File metadata and controls

188 lines (143 loc) · 8.11 KB

Dokumentacja LibreMedia

Ta dokumentacja zawiera szczegółowe informacje techniczne o platformie LibreMedia.

Spis treści

Architektura i projektowanie

Dokument Opis
architecture.md Architektura systemu, komponenty, warstwy
database.md Struktura bazy danych, ERD, modele
api.md Dokumentacja REST API

Funkcjonalności

Dokument Opis
features/users.md Użytkownicy, role, uprawnienia
features/monetization.md Subskrypcje, darowizny, płatności

Infrastruktura

Dokument Opis
deployment.md Instrukcje wdrożenia (Capistrano)

Dla deweloperów

Dokument Opis
development.md Środowisko lokalne, konwencje
testing.md Testy, pokrycie, CI/CD

Quick Links

Kluczowe koncepty

Platforma multimedialna

LibreMedia to platforma dla twórców treści, umożliwiająca:

  1. Publikowanie — posty, wideo, zdjęcia, strony statyczne
  2. Monetyzację — subskrypcje premium, jednorazowe darowizny
  3. Społeczność — obserwacje, komentarze, reakcje, powiadomienia
  4. Wielojęzyczność — pełne wsparcie i18n (PL, EN, UK, LT, DE, FR, ES)

Stos technologiczny

┌─────────────────────────────────────────────────┐
│                   Frontend                       │
│  Hotwire (Turbo + Stimulus) · SCSS · Font Awesome│
├─────────────────────────────────────────────────┤
│                   Backend                        │
│  Ruby on Rails 8.1.2 · Ruby 3.4.6               │
├─────────────────────────────────────────────────┤
│                   Data Layer                     │
│  PostgreSQL 15+ · Redis 7+ · Elasticsearch 8.x  │
├─────────────────────────────────────────────────┤
│                   Services                       │
│  Sidekiq · Stripe · Action Cable                │
└─────────────────────────────────────────────────┘

Role użytkowników

System ról obsługuje role globalne i kontekstualne (przypisane do konkretnego bloga). Szczegóły: features/users.md

Rola Slug Priorytet Uprawnienia
Super Admin super-admin 100 Pełny dostęp do systemu
Admin admin 90 Zarządzanie użytkownikami, treścią, ustawieniami
Moderator moderator 50 Moderacja treści i komentarzy
Author author 30 Tworzenie i edycja własnych treści
User user 10 Komentarze, obserwacje, reakcje
Guest guest 0 Przeglądanie publicznych treści

Typy treści

Typ Model Opis
Post Post Artykuły tekstowe z formatowaniem
Video Video Materiały wideo (YouTube, upload)
Photo Photo Galerie zdjęć
Page Page Strony statyczne

Monetyzacja

Mechanizm Opis
Subskrypcje Miesięczne/roczne plany premium
Darowizny Jednorazowe wpłaty na twórcę
Poziomy dostępu Treści dostępne tylko dla subskrybentów

Diagram architektury

                                    ┌──────────────┐
                                    │   CDN/Edge   │
                                    │  (CloudFlare)│
                                    └──────┬───────┘
                                           │
                    ┌──────────────────────┴──────────────────────┐
                    │                                              │
           ┌────────▼────────┐                          ┌─────────▼─────────┐
           │   Web Server    │                          │   API Gateway     │
           │   (Nginx)       │                          │   (REST/JSON)     │
           └────────┬────────┘                          └─────────┬─────────┘
                    │                                              │
                    └──────────────────────┬───────────────────────┘
                                           │
                                  ┌────────▼────────┐
                                  │  Rails App      │
                                  │  (Puma)         │
                                  └────────┬────────┘
                                           │
           ┌───────────────┬───────────────┼───────────────┬───────────────┐
           │               │               │               │               │
   ┌───────▼───────┐ ┌─────▼─────┐ ┌───────▼───────┐ ┌─────▼─────┐ ┌───────▼───────┐
   │  PostgreSQL   │ │   Redis   │ │ Elasticsearch │ │  Sidekiq  │ │    Stripe     │
   │  (Primary DB) │ │  (Cache)  │ │   (Search)    │ │  (Jobs)   │ │  (Payments)   │
   └───────────────┘ └───────────┘ └───────────────┘ └───────────┘ └───────────────┘

Konwencje

Nazewnictwo

  • Modele: CamelCase (np. PricePlan, MediaAttachment)
  • Tabele: snake_case, liczba mnoga (np. price_plans, media_attachments)
  • Kontrolery: PluralController (np. PostsController)
  • Widoki: snake_case (np. posts/show.html.slim)

Struktura katalogów

app/
├── controllers/          # Kontrolery (Web + API)
│   ├── api/v1/          # API v1
│   └── concerns/        # Współdzielone moduły
├── models/              # Modele ActiveRecord
│   └── concerns/        # Współdzielone moduły (Sluggable, Translatable)
├── views/               # Widoki Slim
├── javascript/          # Stimulus controllers
│   └── controllers/     
├── assets/              
│   ├── stylesheets/     # SCSS
│   └── fonts/           # Font Awesome
├── policies/            # Pundit policies
└── services/            # Service objects

Tłumaczenia (i18n)

Wszystkie teksty UI są tłumaczalne. Pliki locale:

  • config/locales/pl.yml — Polski (domyślny)
  • config/locales/en.yml — English
  • config/locales/uk.yml — Українська

Modele z tłumaczeniami używają Translatable concern z polami *_i18n (JSONB).

Wsparcie

© 2026 Webgate Systems LTD