carpool-service/README.md

33 lines
1.7 KiB
Markdown
Raw Normal View History

2023-03-27 18:54:56 +00:00
# COOPGO Carpool Service
COOPGO Carpool Service is a carpool management microservice. It is part of the COOPGO Technical Platform and the base carpool component of COOPGO's [RIDYGO](https://ridygo.fr) application. It was redesigned from scratch to implement natively the new OCSS carpool standard and bring interoperability.
This is not a full featured carpooling application. There is no UI and it only implements basic carpooling functionalities (create and find, book journeys). The objective of this service is to be embedded in a bigger carpool or Mobility as a Service platform.
It provides a gRPC service to interact with other microservices, and an HTTP API to provide interoperability with external carpooling operators.
## Technical architecture
### Managing trips and journeys
Trips and journeys are managed through the provided gRPC service and stored in the database (MongoDB for the moment). They are stored in the database as GeoJSON feature collections with extra members defining the trips and journeys non-geographical parameters.
### Tiles architecture and cache
To reduce dependencies on the chosen database, we decided to manage geographical calculations directly in out code instead of relying completely on MongoDB geographical features.
For opti
### Search
### Booking
## OCSS standard
The OCSS standard is the new carpooling interoperability standard defined by the french carpooling ecosystem.
COOPGO Carpool Service implements all of this standard, except the messages endpoint which we think should be handled outside of this service, as different carpooling or MaaS applications may handle messaging differently.
## Licence
COOPGP Carpool Service is released under the terms of the AGPL version 3 licence