Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jekingohel/githubprofileapp
This mobile application enables users to search for GitHub profiles, view user details, and navigate followers and following lists. It utilizes the GitHub REST API to fetch user data.
https://github.com/jekingohel/githubprofileapp
Last synced: 10 days ago
JSON representation
This mobile application enables users to search for GitHub profiles, view user details, and navigate followers and following lists. It utilizes the GitHub REST API to fetch user data.
- Host: GitHub
- URL: https://github.com/jekingohel/githubprofileapp
- Owner: jekingohel
- Created: 2024-01-03T12:00:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-05T17:59:17.000Z (about 1 year ago)
- Last Synced: 2024-11-14T13:20:23.375Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 8.33 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub Profile App
This mobile application allows users to search for GitHub profiles by username, view user details, and navigate through followers and following lists. The app fetches GitHub user data using the GitHub REST API.
## Screenshot
## Features
### User Search
- A search bar enables users to fetch GitHub user profiles by username.
- If no user exists with the provided username, a "Not found" view is presented.
- If the user exists, a view displays the user's:
- Avatar
- Username
- Name
- Description
- Follower count
- Following count
### Followers/Following Lists
- Users can tap on the follower/following counts to navigate to a list view.
- The list view displays the user's followers or the users they are following.
- Tapping on a user in the list navigates to their profile view.
### Navigation
- Users can navigate backward through the navigation stack.
### Skeleton Screens
- Add skeleton screens to provide a visual indication of loading.
### Pull to Refresh
- Implement pull-to-refresh functionality to allow users to manually refresh data.
### Profile Caching & Cache Invalidation
- Implement profile caching to improve app performance.
- Add cache invalidation mechanisms to keep data up-to-date.
## Test Cases
#### User Search
- Verify the presence of the search bar.
- Test searching for a user that exists.
- Test searching for a user that doesn't exist.
- Verify the "Not found" view is displayed appropriately.
#### User Details
- Ensure user details are displayed correctly.
- Test navigating to a user's followers list.
- Test navigating to a user's following list.
- Verify the avatar, username, name, description, follower count, and following count.
#### Followers/Following List
- Test tapping on a follower/following count.
- Verify the list view displays the correct user information.
- Test tapping on a user in the list and verify navigation to their profile view.
#### Navigation
- Test navigating backward through the app.
- Ensure the expected views are displayed after navigation.
## Time Investment
The completion of this project required a thoughtful investment of time. The total hours dedicated to the development, testing, and refinement of the GitHub Profile App amounted to 16 hours.
## Production Readiness
- Organize code into modular structures.
- Enhance error handling and logging.
- Optimize performance by employing techniques such as memoization, lazy loading, and image optimization.
- Consider implementing a caching mechanism for frequently requested data.
- Ensure secure handling of sensitive information, such as API keys, by using environment variables.
- Implement loading states and error messages to provide better feedback to users.
- Optimize the Redux store by selectively connecting components and avoiding unnecessary re-renders.
- Implement testing, optimization, and security measures.
- Ensure a good user experience, accessibility, and code quality.
- Follow best practices for version control, commit messages, and branching strategies.
- Set up a CI/CD pipeline for automated testing and deployment.
## Installation
1. Clone the repository:
```bash
git clone https://github.com/jekingohel/GitHubProfileApp.git
```
2. Change into the project directory:
```bash
cd GitHubProfileApp
```
3. Install dependencies:
```bash
# using npm
npm install
# OR using Yarn
yarn install
```
## Usage
Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app:
### For Android
```bash
# using npm
npm run android
# OR using Yarn
yarn android
```
### For iOS
```bash
# using npm
npm run ios
# OR using Yarn
yarn ios
```
If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ or _iOS Simulator_ shortly provided you have set up your emulator/simulator correctly.
This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
## Testing
```bash
# using npm
npm test -- -u
# OR using Yarn
yarn test -- -u
```