Skip to content

mariache/Github_Finder

Repository files navigation

Github Finder

Github Finder is a simple app to search for github users

Getting Started

Demo can be found here

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

Register a new GitHub App to get started developing on the GitHub API and generate access token. You can also read more about building in developer documentation.

Installing

After you generated the token you can clone the repo and use your token to get full access to it's functionality

npm install
npm start

Deployment

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

Built With

  • React - The JS library used
  • ContextAPI - Allows to manage global application states

Contributing

Fork and feel free for submitting pull requests.

Authors

Acknowledgments