Skip to content

Talha-Jamil-TJ/Github-Issue-Explorer

Repository files navigation

Github Issues Explorer

Explore GitHub repositories and view their issues in one web app.

App Features

  • Repository Browsing: List of open repositories, sorted by descending stargazer counts.
  • Issue Viewing: Detailed view of repository issues, sorted by creation date.

Project Features

  • Pagination: Paginated results for both repository listings and issue details.
  • Continuous Integration (CI): Includes running tests, linting, and format checks on every pull request.
  • Continuous Deployment (CD): Automated deployment pipeline using Netlify.

Key Technologies

Key packages and technologies used in this project:

Live Demo

Check out the live app: Github Issue Explorer

Getting Started

Follow these instructions to set up the app locally.

Prerequisites

Install these on your local machine:

Cloning the Repository

Make sure you have access to the repo, then clone it:

git clone https://github.com/Talha-Jamil-TJ/github-issue-explorer.git

Installing Dependencies

Install all necessary dependencies:

npm install

Running the Development Server

Launch the development server:

npm run start
# or nx serve

Navigate to http://localhost:4200/. The app will auto-reload when source files change.

Building the App

To build the project:

npm run build
# or nx build

Build artifacts will be in the dist/ directory.

Running Unit Tests

Execute unit tests with:

 npm run test
 # or nx test

Branch Structure

Overview of the branch organization:

  • main: Latest stable changes.

Component and service with Unit Tests

  • TokenFormComponent
  • TokenService

About

A web app where you can explore repositories and view there issues

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages