Hammy Project Structure

The Hammy Project is organized into several key components, each with distinct roles:

.
├── Dockerfile                # Dockerfile for making a hammy docker image
├── bannerPlugin              # Plugin for showing the hammy banner on boot
│   └── bannerPlugin.go
├── cacheFunction             # CacheFunction for the main webserver
│   └── cacheFunction.go
├── config.yaml               # Config for the hammy build, specified port number and build version
├── docker-compose.yaml       # Docker Compose with a builder, made for testing Hammy with greater ease
├── examples                  # Example configurations of hammy, used for the documentations and guides
│   ├── docker-compose.yaml
│   └── kubernetes.yaml
├── go.mod                    # Default go files
├── go.sum
├── htaccessFunction          # Function for listening to htaccess files
│   └── htaccessFunction.go
├── main.go                   # Main package
├── readme.md                 # Readme
└── serverPlugin              # Serverplugin for starting the webserver and maintaining the connections
    ├── pages                 # Hammy pages, 404, 500 & index
    │   ├── hammy-404.html
    │   ├── hammy-500.html
    │   └── hammy-index.html
    └── serverPlugin.go

        

Hammy works with plugins and functions, a plugin being a part of the hammy code that is called in the main package, a function being an extension of a plugin. So the cacheFunction is being called in the serverPlugin.