annal001 / github-search

An Angular web application that allows users to enter a GitHub username into a form, submit it and view names and descriptions of a person's public repositories.

GithubSearch

An Angular web application that allows users to enter a GitHub username into a form, submit it and view names and descriptions of a person's public repositories among other data.

Description

An Angular web application that allows users to enter a GitHub username into a form, submit it and view repository data such as names, descriptions, the number of forks, programming language used and the date of creation of the repository. Users can also search for specific repositories based on the their repository name or text contained within their descriptions. Moreover, form validation and loaders to enhance the user experience as github user and repositories data is fetched using the github api, have been added.
This project was generated with Angular CLI version 13.3.1.

By Lynn Nyangon

Setup/Installation Requirements

• Using a mobile device/laptop ensure you have access to stable internet connection
• To access the web application's code from your GitHub repository, you can fork the repository main's branch via the 'Fork' button.
• To access the web application's code locally, you can clone the main branch or download the ZIP folder via the 'Code' button
• Once locally, you can view the web application code via a text editor.
• To run the code locally, ensure you have NodeJS and Node Package Manager(NPM) installed.
• Otherwise to view the web application, navigate to the live site below:
  Live Site
• To carry out other operations, the guidelines/commands are as listed below:

  Development server

  Run ng serve for a dev server. Navigate to http://localhost:4200/. The application 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.

  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 a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

  Further help

  To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.

Dependencies

• NodeJS.
• Node Package Manager(NPM).

Technologies Used

• Angular Framework
• HTML - For structure of the page
• CSS - For styling of the page
• Bootstrap - For predefined styles thus speed up development time
• JavaScript/TypeScript - For UI behavior and logic
• Node Version Manager(NVM) - For installation of NodeJS and NPM.

Support and contact details

In case of any queries you can reach out via email; [email protected]

License

MIT License 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) 2022 Lynn Nyangon