Skip to content

πŸ’» Project that aims to consume the GitHub API and display the information on the screen using Vue.js resources

Notifications You must be signed in to change notification settings

eobrunodias/search-user-github

Repository files navigation

πŸ” GitHub User Search

πŸ‡§πŸ‡· Portuguese

πŸ“œ About the Project

Search for GitHub users by username and view detailed information about their profile. It features a minimalist and intuitive interface, and includes a search history that can be saved for future reference.

πŸ’» Pages

Home

The main page where you can search for GitHub users by entering their username. The results display the user's profile information, including their avatar, bio, and public repositories.

Home Page

History

The history page displays a list of previous user searches, allowing you to revisit profiles you've searched for before.

History Page

βœ” Features

  • πŸ” User Search: Enter a GitHub username to fetch and display the user's profile information.
  • πŸ—‚ Search History: Keep track of previously searched usernames, with plans to save this history locally.
  • 🌐 API Integration: Fetch data directly from the GitHub API for real-time results.
  • πŸ’Ύ Local Storage: Save search history even after refreshing or closing the browser.

New Features

  • πŸ—‘οΈ Remove User of History: Easily remove a user from the history with just one click.
  • πŸ“… Search Date: Records the date and time when you searched for a user.

πŸ›  Technologies Used

TypeScript Vue Vite

🀝 Contributing

Where can I improve?

We welcome contributions! Whether it's improvements, bug fixes, or new features, feel free to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/new-feature).
  3. Make your changes and commit them (git commit -am 'Add new feature').
  4. Push your changes (git push origin feature/new-feature).
  5. Open a Pull Request on GitHub.

Project Setup

Install dependencies

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, compile and minify for Production

npm run build

Lint with ESLint

npm run lint

License

This project is licensed under the MIT License. See the LICENSE file for more details.


About

πŸ’» Project that aims to consume the GitHub API and display the information on the screen using Vue.js resources

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published