https://github.com/sarah-marion/github_search
This app utilizes the GitHub API to retrieve, search and display people's GitHub account details.
https://github.com/sarah-marion/github_search
angularjs bootstrap4 html5 ts
Last synced: 10 months ago
JSON representation
This app utilizes the GitHub API to retrieve, search and display people's GitHub account details.
- Host: GitHub
- URL: https://github.com/sarah-marion/github_search
- Owner: Sarah-Marion
- Created: 2018-04-27T08:11:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-31T23:09:59.000Z (almost 3 years ago)
- Last Synced: 2025-01-09T09:20:20.580Z (12 months ago)
- Topics: angularjs, bootstrap4, html5, ts
- Language: TypeScript
- Homepage: https://sarah-marion.github.io/Github_Search/
- Size: 336 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitSearch
## Author
> By **Sarah Marion**
> -----------------------------------------------------------
## Description
> This is an angular app which utilizes the github api to retrieve, search and display people's Github account details.
> https://sarah-marion.github.io/Github_Search/
> This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 1.7.4.
## Requirements (for Users)
> * A user can search a Github username
> * A user can view a person's profile
> * A user can see detailed information of a person's various repositories
> * A user can refresh the page by clicking on the header
## Technical Requirements
> * Placing of access key within the envionment.ts file and placing it within the gitignore file
> * Http service that uses a promise to make requests to GitHub Api
> * Project must have two classes.One for the user and another for the repository
> * Should have a separate routing module that links a Github Username to the users Github repositories
## Development server
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).
## Running end-to-end tests
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
## Further help
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
## Technologies Used
> * AngularJs
> * Node - for Dependancy Management
> * Bootstrap
> * Custom Css
> * Html
## Known Bugs
> It does not have bugs.But if any problems should occur, email me at devsarahmarion@gmail.com
## Support and Contact Details
> You can reach out to me at devsarahmarion@gmail.com
for Reviews, Advice, Collaborations and Comments
## Licence
> MIT License
> Copyright (c) 2018 **Dev Sarah Marion**
> Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
> The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
> --------------------------------------------------------