Empowering JavaScript with github APIs

Working

This app fetches GitHub user data using the GitHub API, displaying public repositories and storing search history in the browser’s local storage. It offers an efficient way for developers to explore and access GitHub projects.

DEMO 😉

https://git-search-repo.vercel.app/

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.js. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository – your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

🤝 Contributing to git-search-repo

If you are feeling super generous, then you can find some issues that you have with the website and try to help us with them. Any kind of positive contribution is welcome! Please help us to grow by contributing to the project.

If you wish to contribute, you can,

  • Create an issue
  • Suggest a Feature
  • Test the app, and help in its improvements.
  • Improve the app, fix bugs, etc.
  • Improve documentation.
  • Create content about git-search-repo and share it with the world. 🆕 New to Open Source? 💡 Follow this guide to jumpstart your Open Source journey 🚀.

🏗️ How to Set up git-search-repo for Development?

You may want to set up the git-search-repo repo for the following reasons:

  • You want to create a new feature or want to edit an existing play as a contributor.

  • You want to contribute to the git-search-repo repo in general by suggesting bugs, issues and improvements.

  • Here is a quick overview of the git-search-repo repo setup:

🍴 Fork and Clone the Repo

First, you need to fork the git-search-repo repo. You can do this by clicking the Fork button on the top right corner of the repo. If you are new to forking, please watch this YouTube Guide to get started.

Once forked, you can clone the repo by clicking the Clone or Download button on the top right corner of the forked repo.

Please change the directory after cloning the repository using the cd <folder-name> command.

⬇️ Install Dependencies

Next, install the dependencies by running the following command in the git-search-repo repo. we recommend using yarn but you can install using npm too

yarn install

Or

npm install

if you don’t have yarn installed on your PC, follow the steps below to install it..

Windows

  1. open your command prompt as administrator.
  2. write corepack enable and hit enter.
  3. then npm install --global yarn

Linux

  1. open terminal and hit npm install --global yarn

MacOS

  1. open terminal and hit npm install --global yarn or brew install yarn

Note: git-search-repo runs on React 18. However, some of our dependencies are yet to upgrade to version 18. So please use the following command when you face difficulties installing the dependencies. Also, ensure to use Node.js version >= 16.x

npm install --legacy-peer-deps

🦄 Start the Development Mode

Use the following command to start the app in the development mode:

yarn dev

or if you installed dependencies using npm use below command

npm run dev

GitHub

View Github