/githubSearch

Its an angular website that searchs a user and their repositories

Primary LanguageTypeScript

GithubSearch

This project was generated with Angular CLI version 6.2.1.

This is a github search application, 23/09/2018

By Abdulfatah Mohamed

ReadmeImg

Description

This is a web application generated with angular cli. It uses the github API to search github users and their repositories. It consists of two pages: A landing page containing the developers information and a search page to search github users and their respositories.

Setup/Installation Requirements

  • To run it on your computer you should install node and angular cli
  • Make sure your computer has an editor you can use atom(preferred), sublime text or notepad++
  • You can view it using a browser such as chrome and mozilla firefox
  • You can use githubs gh-pages to deploy
  • Fork and enjoy There is no database or server setup for this code hence it should be smooth and easy to use. View on Github.

Known Bugs

  • Its not secure for gh-pages so you have to load unsafe script in your browser to open the gh-pages link. You will find in the toolbar.

Technologies Used

  • Angular CLI
  • Typescript
  • HTML
  • CSS
  • Visual studio code
  • Github's gh-pages

Support and contact details

For more information call +254789268466 or Email me fertahrez@gmail.com

License

*MIT License

Copyright (c) 2018 Abdulfatah Mohamed

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.* Copyright (c) 2018 Abdulfatah

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.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.