go-newspaper-display 📰🗞️

Welcome to my go-newspaper-display repository! 🎉 This is where I showcase my love for newspapers and Go programming. 😄

What's Inside? 🔍

Here's a quick overview of what you'll find in this repo:

go-newspaper-display/
├── Dockerfile 🐳
├── README.md 📝
├── cache 📂
├── config.yaml ⚙️
├── docker-compose.yaml 🐙
├── go.mod 📦
├── go.sum 📋
├── main.go 🚀
├── main_test.go 🧪
└── templates
    └── home_with_image.html 🌐

• Dockerfile: The recipe for building our Docker image 🏗️
• README.md: You're reading it right now! 😉
• cache: Where we store our cached newspaper images 🖼️
• config.yaml: Configuration file for specifying PDF URLs and cache time ⌛
• docker-compose.yaml: Defines our Docker Compose services 🐳
• go.mod and go.sum: Go module files for managing dependencies 📦
• main.go: The heart of our application, where all the magic happens ✨
• main_test.go: Unit tests for our application 🧪
• templates/home_with_image.html: HTML template for displaying the newspaper image 🗞️

How to Use 🤔

1. Make sure you have Go and Docker installed on your machine 💻
2. Clone this repository and navigate to the project directory 📂
3. Update the config.yaml file with your desired PDF URLs and cache time ⚙️
4. Run docker-compose up to start the application 🚀
5. Open your web browser and visit http://localhost:8080 to see the newspaper display! 🌐

Running Tests 🧪

To run the unit tests for this project, follow these steps:

1. Make sure you're in the project directory

2. Run the following command:

   go test -v

3. The test results will be displayed in your terminal, showing which tests passed or failed

Contributions Welcome! 🙌

If you have any suggestions, bug reports, or want to contribute to this project, feel free to open an issue or submit a pull request. Let's make this the best newspaper display ever! 📰💪

Happy coding! 👨‍💻👩‍💻