Skip to content

Festivals-App/festivals-gateway

Repository files navigation

Commits Shield Issues Shield SLSA Level 2 Shield License Shield



FestivalsApp Gateway

The service gateway for the FestivalsApp backend, providing access to the FestivalsAPI, FestivalsFilesAPI, database and the website node acting as an ingress server, loadbalancer and discovery service.

Figure 1: Architecture Overview Highlighted


DevelopmentDeploymentEngage


Development

The FestivalsApp Gateway follows a modular structure for clarity and maintainability. The server directory manages API routes and middleware and the operation directory documents deployment and environment. GitHub Actions are in .github, and .vscode provides recommended settings. The entry point is main.go, with dependencies in go.mod and go.sum.

See the Gateway Documentation for details on available endpoints.

The general documentation for the Festivals App is in the festivals-documentation repository. The documentation repository contains architecture information, general deployment documentation, templates and other helpful documents.

Requirements

Deployment

The Go binaries are able to run without system dependencies so there are not many requirements for the system to run the festivals-gateway binary, just follow the deployment guide for deploying it inside a virtual machine or the local deployment guide for running it on your macOS developer machine.

Engage

I welcome every contribution, whether it is a pull request or a fixed typo. The best place to discuss questions and suggestions regarding the festivals-gateway is the issues section. More general information and a good starting point if you want to get involved is the festival-documentation repository.

The following channels are available for discussions, feedback, and support requests:

Type Channel
General Discussion
Other Requests

Licensing

Copyright (c) 2020-2025 Simon Gaus. Licensed under the GNU Lesser General Public License v3.0

About

Providing gateway, discovery and loadbalancing functions for the FestivalsApp project.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published