https://github.com/dhairyamajmudar/git-searcher

(under dev)
https://github.com/dhairyamajmudar/git-searcher

Last synced: 8 days ago
JSON representation

(under dev)

• Host: GitHub
• URL: https://github.com/dhairyamajmudar/git-searcher
• Owner: DhairyaMajmudar
• Created: 2024-02-06T17:56:49.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-02-06T18:48:04.000Z (11 months ago)
• Last Synced: 2024-12-20T12:49:24.733Z (12 days ago)
• Language: TypeScript
• Homepage:
• Size: 62.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Git Searcher - Github User Search Application.

## Setup Guide

1. Install the packages with the script `npm i` or `npm Install` 

2. Now create the GitHub access token by:

a. Go to Settings.

b. Open Developer Settings.

c. Head to Personal Access Token Tab (Tokens Classic)

d. Generate a new token and copy it (The token can be viewed only once so its recommended to store it properly ! ).

3. Generate env variables

a. Create a new `.env` file in the root folder and copy the contents of `.env.example` in it.

b. Paste the GitHub token.

c. now run the application using the script `npm run dev`.

## Tech Stak used

- NextJs

- TypeScript

- Tailwind

- Github GraphQl API

## About Github Searcher

Github Searcher is a web application from which users can find the information of other GitHub users just by searching their usernames. 

Rather than using traditional REST API, the application uses the power of GraphQl Query to fetch only the required information from the API which results in decreased use of bandwidth and increasing performance.

Other than that being built on top of Nextjs makes the application server side, and using tailwind for styling makes the website look more modular and user friendly.

Type safety is taken utmost care with the help of TypeScript resulting in a decreased number of bugs.

`Made with Love by Dhairya Majmudar 🚀⭐`