Skip to content
GitHub Avatar Downloader is a NodeJS project that uses GitHub's API to download avatar photos and store them locally.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.env.example
.gitignore
README.md
download-avatars.js
package.json

README.md

GitHub Avatar Downloader

GitHub Avatar Downloader is an app that uses Node.js to consume the GitHub REST API in order to download user avatars. It is coursework from Lighthouse Labs.

Dependencies

  • dotenv for accessing GitHub API keys
  • fs to save the avatars
  • request for managing HTTP requests

Installation & Setup

Clone this repository and npm install to install the dependencies.

Prior to running, set your GitHub username and GitHub access token in a .env file in the project directory, using the included .env.example as an example:

GITHUB_USER=your_username_here
GITHUB_ACCESS_TOKEN=your_token_here

Run

Run the program using the format...

node download_avatars.js USER PROJECT

... where USER is any valid user (like ty2k) and PROJECT is a project belonging to that user (like github-avatar-downloader).

For instance: node download_avatars.js jquery jquery

Contact the Author

Tyler Krys made this to learn about web development.

You can’t perform that action at this time.