An Angular website consuming the GitHub API to retrieve names and descriptions for public repositories belonging to an user on GitHub: the Version Control Website Service based on git.
Users will:
Enter a GitHub username into a form.
Submit form.
View names and descriptions for the public repositories of that user.
Likewise users of the app can search repositories directly.
Follow this guide to set up the application for use on your local machine.
- Step 1 : Clone this repository using `git clone https://github.com/jumaBrian/github-search.git, or downloading ZIP file of the code.
- Step 2 : The repository, if downloaded as a .zip file will need to be extracted to your preferred location and opened.
- Step 3 : Run this command to have node packages installed at root directory of project: npm install.
- Step 4 : Check for node_modules folder in the project, this file contains packages needed to run your application.
- Step 5: Run this command to start the angular application: ng serve -o
- With access to the internet and a browser.
- You can use live link provided : https://jumabrian.github.io/github-search/
- ANGULAR - web framework for building client applications using TypeScript & HTML.
- BOOTSTRAP - rapid UI CSS based framework.
- GitHub API - to retrieve data from the github server.
jumaBrian
Contact me via Email: [email protected]
MIT License
Copyright (c) 2022 jumaBrian
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.