github-users-by-location

Find and display github users by location search.

About

This project is to display github users by location search. This will be an MVP. A more production project may be started elsewhere.This is a work in progress meant for anyone looking to do some open source fun.

githubusersbylocation.com

Use Case

In searching for a local coding community it can be difficult to have an idea of how large that community is. While not 100% github users is a data point.

Example API call: https://api.github.com/search/users?q=location:Eugene&page=20&per_page=10

Stack

• Version Control: Github
• Frontend: svelt
• Infrastructure: teraform
• Cloud : AWS
• CI/CD: Github Actions
• Rollup : Module Bundler
• Jest: Testing Library

Version Requirements

• Node.js: 20.11.0 (or latest LTS)
• Terraform: 1.4.2
• Svelte: ^3.55.0
• Rollup: ^3.15.0
• Jest: ^29.5.0
• TypeScript: ^5.4.5

API

Github api is used for the searching. Docs: https://docs.github.com/en/rest?apiVersion=2022-11-28

Example API call: https://api.github.com/search/users?q=location:Eugene&page=20&per_page=10

Local Development

Install the dependencies.

cd github-users-by-location 
npm install

...then start Rollup:

npm run dev

Navigate to localhost:8080. You should see the app running.

npm run build

On S3

This is deployed to s3 (manually at the moment. Plans to set up CICD in works).

Current S3 link: https://s3.amazonaws.com/www.githubusersbylocation.com/index.html

Live Domain: http://www.githubusersbylocation.com/

Contributing to this Project

Anyone looking to contribute to this project please read this doc

Contribution

Thank you for your interest in contributing to this project!

Check this link for open issues: https://github.com/antonioortegajr/github-users-by-location/contribute