Diferència entre revisions de la pàgina «Projecte Mensakas»
(→API) |
|||
Línia 57: | Línia 57: | ||
# CONSUMER: Tria Business i afegeix productes al carretó. | # CONSUMER: Tria Business i afegeix productes al carretó. | ||
− | #: /api/business/{ | + | #: /api/business/{postal_code} : llistat restaurants |
− | #: /api/ | + | #: /api/business/{business_id}/products : llistat productes |
# CONSUMER: Confirma comanda (guardada a la DB) | # CONSUMER: Confirma comanda (guardada a la DB) | ||
+ | #: /api/order/checkout : IN comanda OUT: hash comanda + dades banc pagament (nonce) | ||
# CONSUMER: Paga comanda (Order) | # CONSUMER: Paga comanda (Order) | ||
+ | #: ...api Redsys... : url ok/ko | ||
# SISTEMA: Tria Franquícia i notifica comanda. | # SISTEMA: Tria Franquícia i notifica comanda. | ||
+ | #: /api | ||
# BUSINESS: Assignar hora de recollida | # BUSINESS: Assignar hora de recollida | ||
# SISTEMA: geoloc (Business, Consumer, Deliverer) -> notificar Deliverers | # SISTEMA: geoloc (Business, Consumer, Deliverer) -> notificar Deliverers |
Revisió del 19:28, 5 feb 2020
Mensakas és una cooperativa de repartiment a domicili fundada a partir del col·lectiu Raiders Por Derechos, extreballadors de corporacions de repartiment com Glovo o Deliveroo que han decidit no deixar-se explotar per aquestes grans corporacions.
Ens demanen que els ajudem a millorar una aplicació que estan desenvolupant de repartiment a domicili.
Elements de la plataforma
Rol | Interfície | Descripció |
---|---|---|
Administrador | webapp | Pot veure tots els elements del sistema. |
Business (Empreses, Restaurants) | webapp | Visualitza les comandes emeses pels Consumers. |
Deliverer (Repartidor o Mensaka) | app mòbil | Visualitza comandes i les pot acceptar. |
Consumer (client final) | app mòbil | Visualitza Empreses (Restaurants) i menús i pot emetre comandes. |
La plataforma ha de permetre treballar amb els següents elements:
- Menús dels restaurants.
- Tindran Items (productes), Categories (jeràrquiques), Packs i Extres (salses, complements, etc.)
- Orders (Comandes) emeses pels Consumers.
- Tenen estat (emesa, acceptada, recollida, entregada), i carret amb els productes
- Franquícies: un mateix Business pot tenir diverses "delegacions". El Consumer emetrà una única Order, però el sistema decidirà quina franquícia d'aquell Business se'n fa càrrec.
Order lifecycle
App consumers: L'autenticació es dona només a la capa de transport (TLS).
No autentiquem a la capa d'aplicació, i només tenim un ID d'usuari (email) com a identificador. Es podria produir que algú suplanti la identitat d'un altre. Hauria, però, de pagar la comanda (possibilitat poc probable, el pitjor problema és que t'enviïn pizza gratis a casa).
- CONSUMER: Tria Business i afegeix productes al carretó.
- CONSUMER: Confirma comanda (guardada a la DB)
- CONSUMER: Paga comanda (Order)
- SISTEMA: Tria Franquícia i notifica comanda.
- BUSINESS: Assignar hora de recollida
- SISTEMA: geoloc (Business, Consumer, Deliverer) -> notificar Deliverers
- DELIVERER: Acceptar comanda
- DELIVERER: Marcar "comanda recollida"
- DELIVERER: Marcar "comanda entregada"
API
- CONSUMER: Tria Business i afegeix productes al carretó.
- /api/business/{postal_code} : llistat restaurants
- /api/business/{business_id}/products : llistat productes
- CONSUMER: Confirma comanda (guardada a la DB)
- /api/order/checkout : IN comanda OUT: hash comanda + dades banc pagament (nonce)
- CONSUMER: Paga comanda (Order)
- ...api Redsys... : url ok/ko
- SISTEMA: Tria Franquícia i notifica comanda.
- /api
- BUSINESS: Assignar hora de recollida
- SISTEMA: geoloc (Business, Consumer, Deliverer) -> notificar Deliverers
- DELIVERER: Acceptar comanda
- DELIVERER: Marcar "comanda recollida"
- DELIVERER: Marcar "comanda entregada"
Fases del projecte
- Fase 1: Desenvolupament de les webapps core de l'Administrador i dels Restaurants (monolit).
- Fase 2: Desacoblament per components comunicats per APIs per compatibilitzar i unificar el funcionament de les webapps (Admin, Restaurant) i de les apps mòbils (Consumers, Deliverers).
Especificacions no funcionals
- Desenvoluparem en PHP i el framework Laravel.
- L'arquitectura ha de permetre escalabilitat dels servidors per poder augmentar el nombre de peticions per unitat de temps quan sigui necessari.
- La BD serà en MySQL/MariaDB i es desplegarà mitjançant el servei RDS (Relational Database Service) de AWS ja que facilita l'escalabilitat.
Fase 1: Webapps core Administrador i Restaurants
Backlog
- Iniciar projecte en Laravel en un repositori públic a Github.
- Dissenyar models de dades i implementar-los amb la migració inicial.
- Construir seeder amb dades de prova amb tots els rols i
- Implementar autenticació nadiua de Laravel.
- Modificar el model d'usuari per contemplar els diversos rols considerats.
- Construir interfície de l'Administrador:
- Gestió de Comandes (Consumer): visualització, estat (emesa, recollida, repartida), afegir comentaris.
- Gestió de Business (Restaurants): alta, baixa, modificació, franquícies.
- Gestió de Menus (dels Restaurants): alta, baixa, categories, packs, extras
- Gestió de Deliverers: geolocalització, assignació de comandes automàtica.
- Construir interfície per al Business (Restaurant):
- Visualització de comandes entrants.
- Acceptació de comanda.
- Afegir comentaris.
- Assignació hora de recollida.
Documentació addicional
Tenim informació d'un projecte previ que va implementar aquest sistema. Aquesta documentació pot aclarir una mica les necessitats, tot i que podem simplificar moltes funcions que per aquest projecte no necessitem inicialment.
El projecte estava distribuit en 3 bases de dades diferents:
BD Menus
BD Orders