# README
GOP
📝 Table of Contents
🧐 About
GOP: "Git Object Proxy" is a generic library used to implement moduling systems in programming languages. GOP defines two main interfaces that can be used to retrieve and cache resources from different sources. See revision2.md to see design doc.
🏁 Getting Started
See deployment for notes on how to deploy the project on a live system.
Prerequisites
What things you need to install the software and how to install them.
- Go 1.13: currently google cloud functions only support upto the go 1.13 runtime
🔧 Running the tests
go test ./...
🎈 Usage
go run ./cmd/servegop
- This will run a gop server on
localhost:8080
🚀 Deployment
- See .github/workflows/cloud-function-deploy.yml
⛏️ Built Using
- Google Cloud Functions - Deployment
- Google Cloud Storage - Asset caching
- Golang - Server
✍️ Authors
🎉 Acknowledgements
- Go Modules: Athens Project: https://github.com/gomods/athens
# Functions
No description provided by the author
No description provided by the author
NewGopper returns a GopperService for a config; This Gopper can use an os filesystem, memory filesystem or a gcs bucket*/.
ServeHTTP is a http.HandlerFunc, can be used in deployments like cloud functions*/.
# Structs
GopperService is an implementation of Gopper that will fall back to a git retriever if the file can't be found in
its data source */.