StephenRoille / project-0c2b79d8089-part-1

React.js app to search GitHub users

Screenshots

A live version of this project is available at search-github-users-with-reactjs.netlify.app

Usage

Clone this repo to your computer.

git clone https://github.com/StephenRoille/project-0c2b79d8089-part-1.git github-finder

Create a .env.local file and set a private GitHub token to increase your API rate limit,

REACT_APP_GITHUB_TOKEN='ghp_<...>'

Install env-cmd globally,

npm install -g env-cmd

Install all the local dependencies

npm install

Start the development server,

npm run start

Your GitHub token is automatically loaded using the cmd-env library when React starts.

To create a production build simply run,

npm run build

This command creates a build directory that you can serve from a web server (Apache, nginx) or using a CDN platform (Netlify)

Dependencies

This project has the following dependencies,

1. axios (GitHub API requests)
2. react (user interface)
3. react-router-dom (client-side routing)

Reference

Based on the React Front to Back course by Brad Traversy.