Giter Club home page Giter Club logo

visitorbadgereloaded's Introduction

Visitor Badge Reloaded

Coverage Status

Visitor Badge Reloaded is a recreation of the the popular visitor-badge which is no longer maintained, unfortunately. In addition, it was missing some features which made it feel incomplete to me. It was also written using Python which I'm personally not a huge fan of; especially the performance.

There is a similar project made by ESKYoung who forked the project and implemented other features before to customize the badge found here


Features

  • direct replacement (refer to Migrating From Visitor Badge)
  • customizable badge: colour, style, text, logo

Defaults

  • Colour: "blue"
  • Style: "square"
  • Text: "Visitors"
  • Logo: no logo

Migrating From Visitor Badge

Since Visitor Badge Reloaded was made to have all the same features as the original Visitor Badge with extra, even the format of the badges are exact same. This means that all you have to do is replace the url of the badge with https://visitor-badge-reloaded.herokuapp.com/badge?page_id=<your own page_id here>. The total visits will remain the exact same as well.

Settings/Configuration

Examples

``

Options

IMPORTANT: Other than the page_id option, there exists additional styling options and functional options (in the future). More details about the options could be found at the bottom of the Shields.io website. Also, all the options are specified as HTTP parameters!!!

  • page_id=<your id> --> identifies your badge, make this unique to yourself. eg. <your username.visitor.badge.reloaded or <username>-<username>
  • &color=<colour here> --> the hex colour code of your badge, do NOT include the #
  • &style=<style name> --> refer to the Sheilds.IO website for the available options
  • &text=<Some text other than "Visitors"> --> put a customizable label on your badge
  • &logo --> logo to put beside the badge, go to https://simpleicons.org/ for the available names
  • &logoColor --> refer to color for the formatting

Deploying your own instance

If at any point, you feel the need to host your own instace, you could refer to the following information to do so. I personally don't believe in such a need as of this point but you are welcome to do so.

Docker/Kubernetes

This app could be packaged as a Docker image. Just run the relevant commands found in the Makefile. Then deploy to your choosen cloud service or even to your own server. However, note that there is no HTTPS support out of the box as the SSL cert actually just comes from Heroku's site-wide cert.

Heroku (recommended)

Heroku supports Docker containers even with their free instances. The current public instance of the app is deployed there as well. Documentation is found here. All the files necessary to deploy to Heroku is already present with the repository so this should be rather trivial. In addition make deploy-heroku just pushes the git repo to the heroku remote if you have configured Heroku already.

OTHER

IF you have tried any other method of deploying this app elsewhere such as on Glitch or some other Cloud Platform, please send pull requests on your experience so others could benefit from it, that would be greatly appreciated.

"Stuff" Used

  • Golang
  • shields.io badges
  • Docker

TODO (organized in order of highest priority)

  • website homepage
  • more configurable settings and better logging capabilities
  • self-hosted database for caching (Redis probably)
  • more crytopgraphically secure hashing (configurable)
  • analytics??
  • differentiates user by IP
  • differentiates user by Github account???
  • additional TODOs are in the code itself

Contribution

If you are interested in helping make this project better, I highly welcome you to do so. I thank you in advance for your interest. If you are unsure of what you could do to improve the project, you may have a look in TODO list (above), or add to the list yourself

visitorbadgereloaded's People

Contributors

nathan13888 avatar renovate-bot avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.