This is a web application built with React.js, TypeScript, and Sass that allows users to search for Github users and view their profiles. The app utilizes the Github API to fetch user data and display it in an intuitive and easy-to-use interface.
- Search for Github users by their username
- View user profiles, including bio, location, number of followers, following, repositories, and more
- Toggle between dark and light mode
To run the application locally, follow these steps:
- Clone the repository:
git clone https://github.com/CodyJPerry/github-user-search-app.git - Navigate to the project directory:
cd github-user-search-app - Install dependencies:
npm install - Start the development server:
npm start - Open the application in your browser at
http://localhost:3000
To use the application, simply enter a Github username in the search bar and click the "Search" button. The app will fetch the user's profile data and display it on the screen.
Contributions are welcome! If you would like to contribute to the project, please follow these steps:
- Fork the repository
- Create a new branch:
git checkout -b my-feature-branch - Make your changes and commit them:
git commit -am 'Add new feature' - Push to the branch:
git push origin my-feature-branch - Submit a pull request
Credits This application was built with React.js, TypeScript, and Sass by Cody Perry. It utilizes the Github API.
This project is licensed under the MIT License - see the LICENSE file for details.