README

Introducing the Common Gateway - a cutting-edge, advanced technology platform designed to enhance data interaction and exchange for local governments. The Common Gateway is a critical tool for the seamless provision of data to Common Ground services, ensuring smooth, efficient, and secure data transactions.

At its core, the Common Gateway is a plugin-based system, allowing for flexible and customizable operations. It is capable of handling multiple plugins, each with its own unique set of functionalities, encapsulated in the form of installation.json files. The platform comes with a robust Installation Service that can read these installation.json files, understand the plugin's requirements, and create basic schema's accordingly.

But the Common Gateway is more than just a tool for data exchange. It's a comprehensive solution designed to handle a multitude of request types and generate appropriate responses. Whether it's an HTTP GET, PUT, POST, or a user downloading a file, the Gateway is equipped to handle it all. It identifies the endpoint, processes the request, and generates an appropriate response, ensuring that any incoming request can be accurately interpreted and handled.

Moreover, the Gateway follows an API-first approach, developing APIs that are consistent and reusable. It also follows the principles of Role-Based Access Control (RBAC), granting permissions to users and applications based on their roles. This ensures a secure and controlled environment for data exchange.

This is a transformative approach to data management, enabling governments to maintain control over their own data while allowing for efficient communication with Common Ground services. It's not just about data exchange, but also about creating an ecosystem where information is democratized, access is broadened, and operations are streamlined.

The Common Gateway is built with the future in mind, designed to adapt and grow with the needs of local governments and the communities they serve. It brings the power of data exchange to your fingertips, providing a platform that is as intuitive as it is powerful.

Embrace the future of data exchange with Common Gateway. It's time to revolutionize the way your local government handles data, enhancing efficiency, security, and adaptability. With the Common Gateway, you're not just preparing for the future, you're shaping it.

Documentation

Since documentation for a technical application like the common gateway can be a bit overwhelming, we decided to spread it out in different levels of technical difficulty

1. (Non-technical) Aimed at product owners and interested parties with no to little technical background: The product page.
2. (A bit technical) Aimed at architects and engineers: The read the docs page.
3. (Technical) Aimed at developers want to build plugins or use the gateway as backend: Readme files in the codebase.
4. (Very technical) Aimed people who want to improve and extend the code base: In code documentations.

If you don't like to read documentation online there is also a complete manual available in pdf.

CoreBundle

This repository holds the common-gateway Core Bundle code base. For more information about the Common Gateway project, please visit the Common Gateway Documentation.

License

This project is released under the EUPL licence program.