benfluleck / github-search-api

WorkAll

Table of Contents

• Getting Started
• Technology Stack
• Installation
• Testing
• Questions
• Support or Contribution
• Status

Getting Started

This is a clientside javascript application built React JS application. The data exists on endpoints serve through the Github Search Api.

It provides the capabilities of searching through and favouriting some of the users

Technology Stack

Client Side

1. React JS
2. TypeScript

Installation

1. Install Node JS.

2. Clone the repository here

3. [cd] into the root of the project directory.

4. Run pnpm install on the terminal to install project dependecies

5. Start the application:

Build Environments

For Client

Development

pnpm run start:dev

Webpack should open your default browser automatically

• Navigate to http://localhost:3000

Testing

Client side tests - Run pnpm run test on the terminal while within the project root directory.

Client side testing is achieved through the use of jest package and React testing library. jest is used to test javascript code in ReactReact applications. The React Testing Library is a very light-weight solution for testing React components

Questions

For more details contact @benfluleck

Support or Contribution

For any suggestions or contributions or issues please do raise them or email me. For Contributiions, Please clone the repo and implement a PR I would appreciate it

Status

Still undergoing testing