qcdev/github-readme-streak-stats repository overview

⁠Docker GitHub Readme Streak Stats

A Docker container for the GitHub Readme Streak Stats project - Display your total GitHub contributions, current streak, and longest streak on your GitHub profile README.

⁠Introduction

This is a Docker container implementation of DenverCoder1's GitHub Readme Streak Stats⁠ project. It allows you to self-host the streak stats generator service using Docker, making it easy to deploy and maintain.

⁠Quick Setup

1. Create a .env file

2. Add your GitHub token to the .env file:

TOKEN=<your-github-token>

1. Start the container using Docker:

docker run -d --network host --name streak-stats --restart unless-stopped -e APPPORT=9000 qcdev/github-readme-streak-stats

The service will be available at http://localhost:9000

⁠Usage

Once the container is running, you can use it by replacing streak-stats.demolab.com with localhost:9000 in your GitHub streak stats URL:

[![GitHub Streak](http://localhost:9000/?user=qcoudeyr)](https://git.io/streak-stats)

⁠Configuration

The container can be configured using the following environment variables:

• APPPORT: The port the service will listen on (default: 9000)

⁠Docker Details

The container is based on Alpine Linux and includes:

• PHP 8.2 with required extensions
• Apache2
• Inkscape (for PNG rendering)
• Composer for PHP dependencies

The container automatically:

• Installs all required dependencies
• Sets up PHP and Apache
• Configures the application
• Exposes the specified port

⁠Known Issues and Limitations

• The container needs to be able to make outbound connections to GitHub's API
• PNG rendering requires additional memory due to Inkscape requirements

⁠Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

⁠License

This Docker implementation follows the same license as the original project by DenverCoder1.

⁠Acknowledgments

• DenverCoder1⁠ for creating the original GitHub Readme Streak Stats⁠ project
• The Alpine Linux team for providing a great base image