In Go's realm, where Restful APIs flow, A subtle dance of code, unseen yet bright. Whispers of a mind, in shadows glow, Crafting bridges in the digital night. With a wink and a smile, the coders weave, A hidden jest in every line they pen. In this ballet of bytes, they dare to believe, In unseen hands guiding them now and then.
Welcome to GoPhernoMoreDev - where we write Go code and sometimes, it even works!
- Getting Started
- Building - Not Just for Carpenters
- Testing - Because We Care
- Formatting - Not Just Your College Essays
- Dependencies - We All Have Them
- Code Generation - Like Magic, But Real
- OpenAPI - Because Open Is Better
- Docker - Ship It Like FedEx
- Cleanup - Not Just For Your Room
First, ensure Go is installed. It's like the foundation of your house; without it, everything falls apart. Download it from here if you haven't already.
Run the following command and watch the magic happen:
make build
This will build the entire project, including the parts you forgot existed.
We have tests! Yes, believe it or not, we like to check if our code actually works.
-
For unit tests, execute:
make test
-
Integration tests (because more testing equals more fun):
make test-integration
-
End-to-End Tests, for the ultimate "will it blend?" experience:
make test-e2e
Our code is pretty, and yours should be too:
make format
make lint
It's like spellcheck, but for code.
To install our plethora of dependencies:
make deps
To update them (because staying current is cool):
make tidy
For when you're too lazy to write code:
make generate
For the fans of OpenAPI:
make openapi
To containerize the application (because containers are hip):
-
Build it:
make docker-build
-
Run it with Docker Compose (because why do it manually?):
make docker-compose-run
To clean up the mess (i.e., binaries, caches, etc.):
make clean
Contributions are welcome - just make sure your code is more functional than funny.
Remember, a good README is like a good joke - if you have to explain it, it’s not that good. Happy coding!