Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/abhish3kk/repofinder-react


https://github.com/abhish3kk/repofinder-react

authentication axios azure-deployment cicd husky javascript jwt react react-router tailwind tsx vite

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README 

          
---

title: Repofinder React

description: RepoFinder allows users to search GitHub repositories based on various filters such as topics, languages, stars, sorting order, and result limits. Users can log in to save their search preferences.

stack: React, Azure, GitHub Actions, Zustand, TypeScript, Tailwind CSS, Node Express, SQLite, Swagger, Azure Devops, JWT

---



# Repofinder - React



## Live Demo



🔗 **Repofinder Live:** [https://repofinder.abhish3kk.in](https://repofinder.abhish3kk.in)



## Table of Contents



1. [Introduction](#introduction)



   - [What is Repofinder?](#what-is-repofinder)

   - [Features](#features)



2. [Application Architecture](#application-architecture)



   - [Overview](#overview)

   - [Component Breakdown](#component-breakdown)

   - [State Management](#state-management)

   - [API Communication](#api-communication)



3. [Application Flow](#application-flow)



   - [Entry Point (`main.tsx`)](#entry-point-maintsx)

   - [App Initialization](#app-initialization)

   - [Routing & Navigation](#routing--navigation)

   - [Authentication Flow](#authentication-flow)

   - [Fetching and Displaying GitHub Repos](#fetching-and-displaying-github-repos)

   - [Favoriting Repositories](#favoriting-repositories)

   - [Error Handling & Edge Cases](#error-handling--edge-cases)



4. [Tech Stack](#tech-stack)



   - [Frontend Technologies](#frontend-technologies)

   - [Libraries & Dependencies](#libraries--dependencies)

   - [API & Backend Communication](#api--backend-communication)



5. [Project Setup & Installation](#project-setup--installation)



   - [Prerequisites](#prerequisites)

   - [Installation Steps](#installation-steps)

   - [Environment Variables](#environment-variables)



6. [Running the Application](#running-the-application)



   - [Development Mode](#development-mode)

   - [Production Build](#production-build)



7. [API Interaction](#api-interaction)



   - [Health Check API](#health-check-api)

   - [Authentication APIs](#authentication-apis)

   - [GitHub API Calls](#github-api-calls)

   - [Favorites API](#favorites-api)



8. [Folder Structure](#folder-structure)



9. [Deployment](#deployment)

   - [Deployment Steps](#deployment-steps)

   - [Azure Hosting](#azure-hosting)



## Introduction



### What is Repofinder?



Repofinder is a React application that helps users discover GitHub repositories efficiently. It interacts with the GitHub API via a Node.js Express backend, allowing users to search for repositories based on customizable parameters such as **topics, programming language, star count, result limit, sorting criteria,** and more. Users can configure these filters in the **Settings** section to refine their search and find repositories that align with their interests.



### Features



- **Search Repositories by Topic & Language** – Easily filter repositories based on relevant technologies and domains.

- **Find Active & Relevant Projects** – Avoid outdated or inactive repositories by prioritizing projects with recent activity.

- **Sort by Stars & Popularity** – Discover trending repositories based on their star count and engagement.

- **Reduce Overwhelm** – Many top-ranked repositories can be complex or inactive. Repofinder helps users find projects that are easier to contribute to based on recent activity and stack relevance.



## Application Architecture



### Overview



Repofinder follows a **client-server architecture**, where the frontend (React) communicates with the backend (Node.js + Express) to fetch repositories via the GitHub API. The application ensures seamless user authentication, state management, and API communication to provide an interactive user experience.



```mermaid

graph LR;

    User -->|Requests| ReactApp;

    ReactApp -->|API Calls| NodeBackend;

    NodeBackend -->|Fetches Data| GitHubAPI;

    NodeBackend -->|Response| ReactApp;

    ReactApp -->|Displays Data| User;

```



> The diagram above represents the data flow: Users interact with the React frontend, which fetches data from the backend, and the backend queries the GitHub API before returning the results to the client.



### Component Breakdown



```

src/components

├── Card.tsx

├── Combobox.tsx

├── Darklight.tsx

├── Error.tsx

├── Loader.tsx

├── MainContent.tsx

├── Nav.tsx

└── UserDropdown.tsx

```



The application consists of various reusable and structural components, categorized as follows:



#### **Core UI Components**



- **Card.tsx** – Displays repository details such as name, stars, and description.

- **Combobox.tsx** – A searchable dropdown component for selecting options like topics or languages.

- **Darklight.tsx** – Toggles between dark and light themes.

- **Error.tsx** – Displays error messages when API calls fail or when the backend is unreachable.

- **Loader.tsx** – A loading spinner shown during API calls or page transitions.



#### **Structural Components**



- **MainContent.tsx** – The primary layout container that renders content dynamically.

- **Nav.tsx** – The navigation bar containing links and user profile actions.

- **UserDropdown.tsx** – A headless component for user-related actions like logout and profile settings.



### State Management



Repofinder uses a combination of **Zustand** and **Context API** for efficient state management:



#### **Global State Management with Zustand**



Zustand is used for managing application-wide state while ensuring minimal re-renders. The following stores handle different aspects of the app:



```

src/store

├── appStore.ts

├── authStore.ts

├── index.ts

└── settingStore.ts

```



- **`appStore.ts`** – Manages global app settings like theme selection (dark/light mode).

- **`authStore.ts`** – Stores authentication details, including user session and JWT tokens.

- **`settingStore.ts`** – Maintains user-defined search filters (topics, language, stars, etc.).



#### **Context API for UI State**



Context API is used for handling UI-related transient states that don’t require persistence, such as:



- **Loader State** – Controls when to show/hide the loader during API requests and page transitions.



By combining **Zustand** for persistent, app-wide state and **Context API** for temporary UI state, Repofinder ensures a smooth and optimized user experience.



### Folder Structure



```

src

├── AppRoutes.tsx

├── Provider.tsx

├── api

│   ├── api.service.ts

│   ├── axiosInstance.ts

│   ├── config.ts

│   ├── endpoints.ts

│   ├── http.service.ts

│   └── index.ts

├── assets

│   ├── react.svg

│   └── repos.json

├── auth

│   └── ProtectedRoute.tsx

├── components

│   ├── Card.tsx

│   ├── Combobox.tsx

│   ├── Darklight.tsx

│   ├── Error.tsx

│   ├── Loader.tsx

│   ├── MainContent.tsx

│   ├── Nav.tsx

│   └── UserDropdown.tsx

├── contexts

│   ├── authContext.ts

│   ├── healthContext.ts

│   ├── index.ts

│   └── loaderContext.ts

├── hooks

│   ├── index.ts

│   ├── useAuth.ts

│   └── useLoader.ts

├── index.css

├── main.tsx

├── models

│   ├── api.request.model.ts

│   ├── api.response.model.ts

│   ├── app.models.ts

│   ├── app.types.ts

│   ├── github.model.ts

│   └── github.types.ts

├── providers

│   ├── AuthProvider.tsx

│   ├── HealthProvider.tsx

│   ├── LoaderProvider.tsx

│   └── index.ts

├── routes

│   └── index.tsx

├── store

│   ├── appStore.ts

│   ├── authStore.ts

│   ├── index.ts

│   └── settingStore.ts

├── utils

│   ├── enumToArray.ts

│   ├── getLabelFromOption.ts

│   └── index.ts

├── views

│   ├── Dashboard.tsx

│   ├── Login.tsx

│   ├── Register.tsx

│   └── Settings.tsx

└── vite-env.d.ts

```