This repo uses mdbook to generate documentation and just to run all the shell commands.
You can install both tools by running and executing ./install_dependencies.sh. It should work as long as you have cargo installed.
This project uses GitHub Flow to manage release and branches.
Link to documentation (web preview of examples)
To enable logging add this to the main function.
// Set log level based on the environment variable
level, err := logrus.ParseLevel(os.Getenv("LOG_LEVEL"))
if err != nil {
level = logrus.DebugLevel // Default to Debug if parsing fails
}
logrus.SetLevel(level)
logrus.SetFormatter(&logrus.TextFormatter{FullTimestamp: true})And run go command with LOG_LEVEL set to debug
LOG_LEVEL=debug go run .just # Runs `go run .`
just test # Run tests
just book-serve # Build and serve the documentation
just book-deploy # Deploys the documentation
just fmt # formats files