City-portal/README.md

1 KiB

City Portal - A STEAM Club Project (incomplete, this README describes the end goal)

AI note: the old README used to be AI generated. This is no longer the case, and all the code in this project is 100% human-written.

City portal is a local data aggregator: local data is a term I coined to mean data that only matters to a specific geographical community. This can range from weather, to events at the local town hall, to transportation. City Portal provides an open and extendable way to use this data, exposing a GraphQL API that anyone is free to read from, but write access can be restricted.

The City Portal is adaptable to different scenarios: by customizing the different datasets that the server stores and that data can be stored into, the managers of the Portal can decide what kinds of local data is stored, but still have this data categorized neatly by function.

Finally, because of its free to read API, the City Portal promotes extension: anyone is free to build ML models, graphs, or visualizations on top of the Portal.