Certainly! Here's the README file template without the screenshots:
GitHub Search App is a web application that allows users to search for GitHub profiles and access their information with ease.
- Search for GitHub usernames and view their profiles.
- Dark mode theme toggle for comfortable usage in different lighting conditions.
- Add favorite GitHub accounts to a list for quick access.
- Clear the list of favorite accounts.
- Responsive design for various screen sizes.
-
Clone the repository:
git clone https://github.com/KesraouiMohamed1991/github-search-app.git
-
Open
index.html
in your web browser to start using the app.
- Enter a GitHub username in the search input and click the "Search" button.
- View the retrieved user information, including their avatar, name, bio, and more.
- Toggle between light and dark mode using the theme switcher.
- Add your favorite GitHub accounts to the list by clicking the star icon.
- Click the "Favorites" button to view your list of favorite accounts.
- Remove all favorites by clicking the "Clear" button.
- Click the "X" button in the top-right corner of the pop-up window to close it.
- HTML5
- JavaScript
- Tailwind CSS
This project is licensed under the MIT License - see the LICENSE file for details.
- Icon credits: icons8
Feel free to further customize this template to match your project's information and structure.