Github Dev Finder

A github developer finder application. This project is designed for fast performance, scalability, and maintainability.

Figma link to the UI design

Core

• Built with React 18 and TypeScript for type safety and modern development practices.
• Vite for lightning-fast development and build processes.
• ESLint and Prettier integration for consistent code quality.
• Uses React Query and Axios for fetching developer profiles.
• Uses React Context for sharing state globally.

Features

• Search for GitHub users by their username.
• See relevant user information based on their search.
• Switch between light, dark and system (light/dark) themes.
• Toggle between (5) color schemes.
• View the optimal layout for the app depending on their device's screen size.

Getting Started

Follow these steps to set up the project locally:

Prerequisites

• Node.js (>= 16.x)
• npm (>= 8.x) or yarn (>= 1.x)

Installation

1. Clone the repository:

   git clone https://github.com/uchedotphp/dev-finder-react
   cd dev-finder

2. Install dependencies:

   npm install
   # or
   yarn install

3. Start the development server:

   npm run dev
   # or
   yarn dev

4. Open your browser and navigate to http://localhost:5173.

Building for Production

To build the project for production: