/Github-API

Git Hub App is an application that allows users to search for repositories and repository information on Git hub.

Primary LanguageTypeScript

Github App

By Ann Wanjeri

Table of Content

  1. Development server
  2. Build
  3. Description
  4. Behaviour Driven Development
  5. Installation
  6. Technology Used
  7. Running unit tests
  8. Running unit tests

Description

This project was generated with Angular CLI version 13.3.1. This project enables users to search for github accounts or profiles and obtain repositories and relevant information associated with the profiles.

Behaviour Driven Development

  • A user is able to search for github repositories
  • A user can obtain information of repositories(forks,watchers,collaborators)

Installation

** Requirements **

  • A computer, tablet or Ipad
  • Access to the internet

Ensure node.js and Angular CLI is installed on machine

Clone the github repo

Technlogy Used

  • CSS
  • HTML
  • JS -Angular
  • Type script
  • Bootstrap

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.

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.