docs: add logo, README, architecture, deploy, wiki, analysis
This commit is contained in:
1 parent
32245f76ac
commit
15eb4016de
9 files changed
+561
-1
No files matched your search
@@ -0,0 +1,78 @@
|
||||
# Wiki di Bookish
|
||||
|
||||
## Guida all'uso
|
||||
|
||||
### Convertitore
|
||||
|
||||
1. Apri la homepage di Bookish
|
||||
2. Trascina un file nell'area di upload, oppure clicca per selezionarlo
|
||||
3. Scegli il formato di destinazione cliccando su un bottone
|
||||
4. Clicca **Converti**
|
||||
5. La barra di progresso mostra lo stato della conversione
|
||||
6. A conversione completata, clicca **Scarica file**
|
||||
7. Opzionale: clicca **Leggi nel reader** per visualizzare il file convertito
|
||||
|
||||
### Formati supportati
|
||||
|
||||
| Input | Output |
|
||||
|---|---|
|
||||
| EPUB | EPUB, MD, DOCX, PDF, TXT, HTML, FB2, LaTeX |
|
||||
| PDF | EPUB, MD, DOCX, TXT, HTML, LaTeX |
|
||||
| DOCX | EPUB, MD, PDF, TXT, HTML, LaTeX |
|
||||
| Markdown | EPUB, DOCX, PDF, TXT, HTML, LaTeX |
|
||||
| TXT | EPUB, MD, DOCX, PDF, HTML, LaTeX |
|
||||
| HTML | EPUB, MD, DOCX, PDF, TXT, LaTeX |
|
||||
| FB2 | EPUB, MD, DOCX, PDF, TXT, HTML, LaTeX |
|
||||
| LaTeX | EPUB, MD, DOCX, PDF, TXT, HTML |
|
||||
|
||||
### Reader
|
||||
|
||||
1. Vai su **Reader** nella navigazione
|
||||
2. Carica un ebook (EPUB, PDF, MD, TXT, HTML, FB2, DOCX)
|
||||
3. Usa la toolbar per:
|
||||
- **☰** — Apri/chiudi indice
|
||||
- **A− / A+** — Zoom font
|
||||
- **☀️ / 🌙 / 🟤** — Cambia tema (chiaro/scuro/seppia)
|
||||
- **🔍** — Cerca nel testo
|
||||
- **⛶** — Schermo intero
|
||||
4. Naviga con frecce tastiera ← → o cliccando ai lati
|
||||
5. La posizione di lettura viene salvata automaticamente
|
||||
|
||||
### API Endpoints
|
||||
|
||||
| Metodo | Path | Descrizione |
|
||||
|---|---|---|
|
||||
| POST | `/upload` | Carica file e avvia conversione |
|
||||
| GET | `/progress/<task_id>` | SSE stream progresso |
|
||||
| GET | `/download/<filename>` | Scarica file convertito |
|
||||
| GET | `/formats?input=<ext>` | Formati disponibili per input |
|
||||
| GET | `/reader` | Pagina reader |
|
||||
| GET | `/reader/<filename>` | Reader per file specifico |
|
||||
| GET | `/reader/serve/<filename>` | Serve il file al reader |
|
||||
| GET | `/reader/formats` | Formati supportati dal reader |
|
||||
|
||||
## Domande frequenti
|
||||
|
||||
**D: Che qualità ha la conversione?**
|
||||
R: Pandoc preserva titoli, grassetto/corsivo, elenchi, tabelle semplici e immagini. Per layout complessi (es. PDF con colonne multiple) la fedeltà dipende dalla complessità del file originale.
|
||||
|
||||
**D: I file vengono conservati?**
|
||||
R: No, vengono cancellati dopo 1 ora. Usa il download subito dopo la conversione.
|
||||
|
||||
**D: Quanto spazio serve?**
|
||||
R: Minimo. L'app stessa è ~5MB. Pandoc binary incluso ~35MB extra.
|
||||
|
||||
**D: Posso usarlo su mobile?**
|
||||
R: Il convertitore è responsive. Il reader funziona ma non è ottimizzato per schermi piccoli.
|
||||
|
||||
**D: Come cambio la secret key?**
|
||||
R: Imposta `BOOKISH_SECRET` come variabile d'ambiente prima di avviare.
|
||||
|
||||
## Sicurezza
|
||||
|
||||
- Uso personale — nessuna autenticazione implementata
|
||||
- File validati per estensione all'upload
|
||||
- Path traversal prevenuto con `os.path.basename()` e `secure_filename()`
|
||||
- MIME types controllati al download
|
||||
- Limite file a 50MB
|
||||
- Pulizia automatica file temporanei
|
||||
Reference in new issue
Block a user