wil-gerard / dev-locator

Find GitHub users by location

Dev Locator

Dev Locator is an application that allows users to easily find and connect with fellow devs by location using GitHub's search API

Features

Current

• Search GitHub users by location
• View total amount of GitHub users at the queried location
• Navigate search results through a paginated list
• Search results display GitHub username, profile picture, and a link to their GitHub page

Improvements

• Display amount of queries available within GitHub's search API rate limit
• Allow users to fetch a specific search results detailed information (bio, followers, following, total stars, etc.)
• Store previous page results in a proxy state using Valtio

Style, Design, And Architecture

Preview

Built With

• TypeScript
• React
• Tailwind CSS
• Valtio

Quickstart:

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node v16 or higher
• Yarn

Running locally

• Clone repo
  • git clone https://github.com/wil-gerard/dev-locator.git
• Install dependencies
  • yarn
• Navigate to the root directory in your terminal and then
  • yarn start

License

MIT License - see the LICENSE.md file for details