Skip to content

Latest commit

 

History

History
63 lines (46 loc) · 2.84 KB

README.md

File metadata and controls

63 lines (46 loc) · 2.84 KB
Raw

Logo

GitFinder is a web application built as a part of Fyle Frontend Internship Challenge.

It allows users to search for other GitHub users by username and view their profile, including their repositories, followers, following, location.

colored line

Live Site : https://gitfinder-7735d.web.app/

Steps for setup and usage

Features 🔥

  • 📱Responsive web application, built on modern web technologies such as Angular and Tailwind CSS.
  • Utilizes the GitHub API to access data.
  • Stores search cache to reduce API requests and provide faster access to data.
  • Easy to use and intuitive user interface.

Installation 💻

  • Go to Angular offical page and follow the instructions to install latest Angular CLI
  • Download all the file from the repo and keep it in a folder
  • Run command npm install or yarn install (yarn is prefered)
  • Running the above command will install all the required dependicies to run the application
  • Go to https://github.com/settings/developers and create a new OAuth App
  • After successfull creation of app, copy the CLIENT_ID and CLIENT_SECERT

Modification 📝

  • Go to github.service.ts in ./src/app/service
  • Replace the keys & save it. This would give access to more API requests.
    private clientID = 'your client ID'
    private clientSecret = 'your client secret'
  • Start the development server by running ng serve or yarn start

🔥 GitFinder is ready 😎 start searching💫

At this point GitFinder is basically ready visit http://localhost:4200/
To use GitFinder, simply enter the username of any GitHub user into the search bar and hit enter.
The application will then display the user's profile, including their repositories, followers, following, location, current working status, etc.

colored line

Components

image

gitfinder (1)

gitfinder (2)

💫 GitFinder. Made with ❤️ by Gagan Kumar 🔥

🤙 +91-9036644552 gagankumar8711@gmail.com 📫