karthikjeeyar/githubexplorer

Github Explorer is git user search feature, built on angular 6 and nodeJs.

GitExplorer

GitExplorer, is a simple, lightweight and fully responsive web application to search github users and their repositories.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

node v.8.9.0 or greater version

Installing

To install the project, please follow the steps described below.

git clone https://github.com/karthikjeeyar/githubExplorer.git

After cloning, cd into the newly created folder and duplicate the .env.example file, save it as .env and replace dummy values with the correct values.

For starters, please run the following command to install the dependancies

yarn setup

Returning users can run the following command

yarn start

On successful installation, you should see the following log in your console

Listening on port 3000

Running the tests

Run the following command to test

yarn test

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Angular 6 - Frontend SPA
• NodeJs - Backend

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.