Giter Club home page Giter Club logo

github-enchanter-list's Introduction

Project thumbnail

Github enchanter list

List of cool static and dynamic badges for your README.


About โ€ข Getting started โ€ข Technologies โ€ข Authors โ€ข Acknowledgements


๐Ÿง 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

github-enchanter-list's People

Contributors

hiyudev avatar

Stargazers

 avatar

Forkers

kylenoome

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.