https://github.com/hiteshpr/github-stats
https://github.com/hiteshpr/github-stats
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/hiteshpr/github-stats
- Owner: hiteshpr
- Created: 2021-11-09T14:40:50.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2021-11-11T04:54:42.000Z (over 3 years ago)
- Last Synced: 2024-12-25T14:20:22.381Z (5 months ago)
- Language: TypeScript
- Size: 188 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Github Stats
Github Stats is a web application that shows the public profile of a GitHub user.
Data shown for a particular user -
- GitHub user name
- GitHub profile picture
- GitHub profile bio
- Number of public repos of the user on GitHub
- Number of followers
- Number of accounts user is following
- Name of the user (optional)
- Location of the user (optional)
To search for a particular user's data, enter their GitHub user-name in the input box provided.
## Technical stack
The web-app is build using Angular 11.
For styling [Angular Material](https://material.angular.io/) is used.
For storing the user's search history
[Akita state management library](https://datorama.github.io/akita/) is being used .
Data is being fetched from [GitHub public API](https://docs.github.com/en/rest/overview).
## Demo video
https://user-images.githubusercontent.com/19280178/141238135-e8874f22-55ea-4307-8558-de8127226ba7.mp4
## Development environment
Fork and Clone the repositry on your system.
Run `npm install` to install node-modules.
Run `ng serve` for a dev server.
Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
## Code scaffolding
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
## Build
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
## Running unit tests
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).