andrewjbateman / ionic-angular-github

:clipboard: App to search for a Github profile using the Github API then display key info using ion-cards

⚡ Ionic Angular Github

• App to search for and display github data for a user from the github API using the Ionic framework.
• Note: to open web links in a new window use: ctrl+click on link

📄 Table of contents

• ⚡ Ionic Angular Github
  • 📄 Table of contents
  • 📚 General info
  • 📷 Screenshots
  • 📶 Technologies
  • 💾 Setup
  • 💻 Code Examples
  • 🆒 Features
  • 📋 Status & To-do List
  • 👏 Inspiration
  • 📁 License
  • ✉️ Contact

📚 General info

• The Github API has a lot more detailed functionality available

📷 Screenshots

📶 Technologies

• Ionic v7
• Angular v16
• Ionic/angular v7
• github API

💾 Setup

• npm i to install dependencies
• ionic serve to start the server on localhost://8100

💻 Code Examples

• Extract from user-search.page.html to search for Github repos using username input text

  <ion-searchbar
    color="primary"
    type="search"
    placeholder="search name"
    [debounce]="1000"
    (ionInput)="handleInput($event)"
  >
  </ion-searchbar>

🆒 Features

• The side menu is activated by the burger menu and extends from the left hand side

📋 Status & To-do List

• Status: Working menu system but page content to be added and fr & es texts to be corrected.
• To-do: Fix dark mode switch mode, Info page, i18n, replace sidebar image. Change search result page to be a user profile with number of repos etc. and a photo.

👏 Inspiration

• github API documentation

📁 License

• This project is licensed under the terms of the MIT license.

✉️ Contact

• Repo created by ABateman, email: [email protected]