This Github User Lookup Application is a single page application that allows users to search for github users using their usernames and display the user's github information. With this application, a user is able to:
- Search for a github user using their username.
- View a user's list of github repos.
- View a user's followers.
- View a list of who the user is following.
You need the following to start working on the project on your local computer:
- A computer running on either Windows, MacOS or Ubuntu operating system installed with the following:
-A Web Browser
-A text Editor
-Angular CLI
-Typescript
-Nodejs
-watchman
To get started with this project on your local computer, clone the project onto your location of choice. Navigate into this folder using command line and first make sure that node modules are upto date by running npm update on the command line. After this run ng serve to start a local server. You may then navigate to http://localhost:4200/ on your web browser to view the project Alternatively, you may also view the application by visiting https://ppolle.github.io/github-user-lookup
- Bootstrap - The front end framework
- CSS3
- Typescript
- Angular CLI
- Npm
- Font Awesome Icons
- Github API
MIT License
Copyright (c) 2018 Peter Polle
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 Peter Polle