Antonio De Lucreziis 39c793583b | 2 years ago | |
---|---|---|
_frontend | 2 years ago | |
auth | 2 years ago | |
database | 2 years ago | |
events | 2 years ago | |
handlers | 2 years ago | |
lupus | 2 years ago | |
model | 2 years ago | |
routes | 2 years ago | |
util | 2 years ago | |
.gitignore | 2 years ago | |
LICENSE | 2 years ago | |
README.md | 2 years ago | |
go.mod | 2 years ago | |
go.sum | 2 years ago | |
main.go | 2 years ago |
README.md
Lupus Lite
Usage
# Development Mode: also starts "npm run dev" inside "_frontend/"
$ MODE=dev go run .
# Production Mode
$ cd _frontend
$ npm run build
$ go build
Architettura
Moduli principali (cose che vengono eseguite e fanno cose di business logic)
-
Entry point principale del server, qui vengono inizializzate concretamente tutte le dipendenze dei vari moduli (come database, router http e servizio di autenticazione).
Per ora usiamo un semplice database ed un semplice servizio di autenticazione per le sessioni di accesso che tengono tutto in memoria (più avanti passeremo a SQLite, tanto basterà semplicemente scrivere un'altra implementazione per
database.Database
) -
Questo modulo dipende molto dal router HTTP in quanto contiene tutte le route del server. Oltre questo dipende solo dal modulo
/handlers
e non sa nulla di/database
e/auth
. -
Questo modulo permette di testare tutta l'applicazione in modo isolato dal resto in quanto non sa nulla dei router HTTP e dipende solo da
/auth
e/database
(ed anche da/events
,/model
e/util
ma questi sono moduli "puri") che possono essere facilmente mocked.
Moduli secondari (o boh "terminali" nel senso che dipendono solo da cose esterne a questo progetto)
-
Questo modulo fornisce una struttura dati di "EventBus" che permette di mandare e ricevere eventi all'interno dell'applicazione.
-
Questo modulo contiene i modelli di tutte le strutture usate nel database ed alcuni metodi di servizio come
User.PublicUser()
che converte unUser
inPublicUser
che rappresenta la versione "sicura" senza i campi segreti (come l'hash della password) dell'utente. -
L'interfaccia principale è
Database
e contiene tutte le operazioni possibili da fare sul database. Per ora c'è solo un'implementazione in memoria data da*memDB
-
L'interfaccia principale è
AuthService
e contiene alcuni metodi per autenticare e registrare gli utenti e creare token di sessione. Per ora l'unica implementazione è*memAuth
e dipende da un'istanza didatabase.Database
e tiene i token di sessione in memoria. -
Questo modulo contiene alcune funzioni di utility e per ora anche varie funzioni di validazione dei form che arrivano dalla frontend, come validazione di username e password per la registrazione degli utenti.
Ed infine c'è il modulo che si occupa del far avanzare le partite e della risoluzione automatica.
-
Questo modulo non dipende da nulla, l'idea è che conterrà le strutture per gestire lo stato delle partite e gli algoritmi per la risoluzione automatica di quest'ultime.
Al massimo potrebbe contenere alcune informazioni su come serializzare lo stato delle partite però per ora tutte le strutture qui dentro sono annotate per essere serializzate a JSON ed anche quando passeremo ad SQLite forse converrà fare sempre così.
TODO: Al massimo potrebbe dipendere da
/model
ma forse non serve.