dianatofan / githubUserSearch

Search for users on Github

Github user search

Application that searches for Github users based on their username.

Solution

The solution is published on the following website:

https://diana-tofan.github.io/githubUserSearch

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

This project is using NPM, hence you will need Node.js installed on your environment.

After the installation you should be able to run:

$ node --version
v11.12.0
$ npm --version
6.7.0

Installing

1. Clone the repository

   $ git clone https://github.com/diana-tofan/githubUserSearch.git
   

2. Go to project folder

   $ cd githubUserSearch
   

3. Install dependencies

   $ npm install
   

Start and watch

$ npm start

Simple build for production

$ npm run build

Deployment

$ npm run deploy

Built With

• React.js - The web framework used

Authors

• Diana Tofan - https://github.com/diana-tofan/githubUserSearch

Implementation Choices

React.js was mainly used for simplicity, performance, testability and a smooth state management.