Github Issues

The project goal is to implement a small client application using Nextjs and GitHub GraphQL API.

The data is obtained from Github React using the Github GraphQL API, and it allows users to see a list of Github issues and filter this list by State (Open/Closed).

Used GraphQL API Explored to see Schema and run Queries.

Project Set-up

For security reasons and to avoid exposing sensitive data, the NEXT_PUBLIC_GITHUB_ACCESS_TOKEN is set in a .env.local file, so to run the project locally you have to:

1. Create your personal access Github token

2. Create the .env.local file in the root folder and set the values as follows:

NEXT_PUBLIC_GITHUB_ACCESS_TOKEN=<your_github_token>

Steps to run Locally

1. Clone repo to local machine
2. Run npm install to install dependencies
3. Create .env.local file on the root folder and add value for NEXT_PUBLIC_GITHUB_ACCESS_TOKEN
4. Run npm run dev
5. Open http://localhost:3000 with your browser to see the result

To run Jest tests

1. Run npm run test

Tech stack

• Next.js
• Apollo GraphQL
• React
• Material UI icons
• MomentJS
• Typescript
• Styled Components
• Jest
• React Testing Library

Improvements

• Change pagination strategy
  • Use Router
• Handle errors
• Improve UI
• Improve flaky tests
• Store in cache
• Add Cypress E2E tests