antoine-js / search-repo-app

Search repositories on Github

Github Repository Search App

This is a simple web application that allows you to search for repositories on Github.

How to Start the App

To get started with the Github Repository Search App, follow these steps:

1. Clone the repository to your local machine by running the following command in your terminal:

git clone https://github.com/antoine-boue/search-repo-app.git

2. Navigate to the project directory by running:

cd search-repo-app

3. Install the dependencies by running:

npm install

4. Start the application by running:

npm run dev

This will start the development server and open the application in your default browser.

Usage

To use the Github Repository Search App, follow these steps:

1. Type in the name of the repository you want to search for in the search bar.

2. Press the "Enter" key or click the search button.

3. The app will display a list of repositories that match your search query.

4. Click on any repository to go its GitHub page.

Screenshots

Here are some screenshots of the Github Repository Search App:

Search for repositories by typing in the search bar.

View the list of repositories that match your search query.

Technologies Used

The Github Repository Search App is built using the following technologies:

• Vite
• React
• Typescript

Contributing

If you would like to contribute to the Github Repository Search App, please follow these steps:

1. Fork the repository.

2. Create a new branch for your changes.

3. Make your changes and commit them with a descriptive commit message.

4. Push your changes to your forked repository.

5. Open a pull request to the original repository with a detailed description of your changes.

License

The Github Repository Search App is licensed under the MIT License. Feel free to use, modify, and distribute the code as you see fit.