Skip to content

GitBuddy is an iOS application built using UIKit that helps users fetch and view the profile and followers of any GitHub user. Users can save their favorite profiles with persistence, and the app uses the GitHub API to retrieve data. The codebase is well-structured with proper modularity.

License

Notifications You must be signed in to change notification settings

DEV-D-GR8/GitBuddy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitBuddy

GitBuddy is an iOS application built using UIKit that helps users fetch and view the profile and followers of any GitHub user. Users can save their favorite profiles with persistence, and the app uses the GitHub API to retrieve data. The codebase is well-structured with proper modularity.

Index

Features

  • View GitHub user profiles
  • Fetch and display followers of a GitHub user
  • Save favorite profiles
  • Persistent storage of favorite profiles
  • Clean and modular codebase

Requirements

  • iOS 13.0+
  • Xcode 11.0+
  • Swift 5.0+

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/GitBuddy.git
  2. Navigate to the project directory:

    cd GitBuddy
  3. Open the project in Xcode:

    open GitBuddy.xcodeproj
  4. Build and run the project in Xcode.

Usage

  1. Launch the app on your iOS device or simulator.
  2. Enter the GitHub username you want to search for.
  3. View the profile and followers of the user.
  4. Save profiles to your favorites for quick access later.

YouTube Demo

Watch the YouTube demo video to see GitBuddy in action.

API

GitBuddy uses the GitHub API to fetch user profiles and followers.

Endpoints Used

  • GET /users/{username} - Fetches the profile of a GitHub user.
  • GET /users/{username}/followers - Fetches the followers of a GitHub user.

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them:
    git commit -m 'Add some feature'
  4. Push to the branch:
    git push origin feature/your-feature-name
  5. Create a pull request.

License

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

About

GitBuddy is an iOS application built using UIKit that helps users fetch and view the profile and followers of any GitHub user. Users can save their favorite profiles with persistence, and the app uses the GitHub API to retrieve data. The codebase is well-structured with proper modularity.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages