Github Emojis

Overview

This product is a small project created to solve the problem of loading and searching emojis supported by Github. The creator, who often uses emojis in their Github commit messages, found it difficult to load the entire emoji list from existing solutions, so they decided to create a more efficient and user-friendly solution. The project utilizes Next.js, Chakra UI, Typescript, FaunaDB, and Vercel for deployment.

Features

• Lazy Loading Emojis from Github Emoji API using Intersection Observer API
• Search Feature with debounce
• Utilizes Incremental Static Regeneration to serve data as soon as possible and revalidate stale data to avoid rate limiting by Github
• Dark / Light theme switcher
• Minimalistic and smooth UI
• PWA Enabled

Installation

To install the theme, follow these steps:

1. Clone or download the project from the Github repository.
2. Open the project in your preferred code editor.
3. Install the necessary dependencies by running the following command in the terminal:

   npm install
   

4. Configure the project with your desired settings, such as the Github Emoji API and any other customizations.
5. Start the local development server by running the following command in the terminal:

   npm run dev
   

6. Open your web browser and access the theme at http://localhost:3000.

Summary

This small project offers a solution for loading and searching emojis supported by Github in a more efficient and user-friendly way. It utilizes lazy loading, search functionality, and a minimalistic UI design. Additionally, it makes use of Incremental Static Regeneration to serve data quickly and avoid rate limiting by Github. The theme also includes a dark/light mode switcher and is PWA enabled.