Goals.

By Williams Oditi

Table of Contents

• Description
• Project resources
• Installation
• Technologies used
• Contact Information
• Known Bugs
• Copyright and License

Description

This is an application that allows a user to search for github users and have their github information displayed - Their profile photo and a list of their repositories.

Project Resources

The following is a live link to the project's site

Link : https://williamsoditi.github.io/Goals/

Installation

Requirements

• An access to the internet
• Either a smartphone, computer or tablet
• A web browser of choice, Most preferrably Google Chrome

Setup

To clone this repository locally, type the following command on your terminal.

https://github.com/Williamsoditi/Goals.git

If using SSH keys, then type:

git@github.com:Williamsoditi/Goals.git

On running the commands successfully, you should have a local version of this repository.

To access the webpage via an IDE; 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.

• For an online repository, Make sure you have a stable internet for forking this repository. According to the license, you can fork this project. You need to click on the forking icon and it will be added as one of your repositories. Feel free to fork the project and add neccessary changes.

Further development

• Before cloning, you need to have Angular CLI and npm installed.
• Run ng build to build the project. The build artifacts will be stored in the dist/ directory.
• 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.
• Run ng test to execute the unit tests via Karma.
• 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
• To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page

Technologies used

• This project was generated with Angular CLI version 13.3.0.
• HTML5, CSS3

Contact Information

• Author E-mail ; williamsoditi99@gmail.com
• Phone Number: +254 712345678.

Known Bugs

There is no known form of data storage.

Copyright and License information

Copyright (c) 2022 Williams Oditi

MIT LICENSE

Copyright (c) 2022 Williams Oditi

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.