/github-enchanter-list

🚀 List of cool static and dynamic badges to boost your README

Primary LanguageTypeScriptMIT LicenseMIT

Project thumbnail

Github enchanter list

List of cool static and dynamic badges for your README.


AboutGetting startedTechnologiesAuthorsAcknowledgements


🧐 About

🧠 Problem Statement

Most of all repository badge list was already preset with a default styling and didn't give the user the ability to customize freely.

💡 Idea / Solution

To solve this problem, the website I created shows all the badges in real-time with a configuration section, so users can have fast visual feedback while customizing.

Using mainly the technologies Next.JS and Tailwind.css for the project, I'm incredibly thankful for all of the libraries creators I used on this project, like Zustand for storing states, RadixUI for accessible components, superjson for easy communication between client side and server side, fuzzysort to search on lists, SWR for fast fetching and infinity scrolling support along react-infinite-scroll-component.

Project mockups

🏁 Getting Started

🎐 Prerequisites

Prerequisites for this project are:

  • Node.js version 12.22.0 or later
  • MacOS, Windows (including WSL), and Linux are supported

✨ Installing

A step-by-step to install and run the project locally.

  1. Clone the project using the following command or install the zip:
git clone https://github.com/Hiyudev/github-enchanter-list.git
  1. Install all the dependencies:
yarn install
  1. Run the project:
yarn start
  1. Open http://localhost:3000 in the browser

⚙ Built with

Technologies

Next.js React Tailwind CSS Vercel RadixUI Jest

Tools

Prettier ESLint Figma

✍️ Authors

🎉 Acknowledgements

© License

  • MIT License