/javascript-github-api-codeReview

Code Review #1 for JavaScript @ Epicodus

Primary LanguageJavaScript

GitHub API Code Review

First JavaScript Code Review for Epicodus PHP, 3.18.2016

By Mary Warrington

Description

This web app is designed to allow a user to enter a github username and see a returned list of repository names and description (if applicable). They can then click on the repository name to go to that repository on github.

Setup/Installation Requirements

Setup of databases

  1. Fork and clone this repository from gitHub.

  2. Navigate to the root directory of the project in which ever CLI shell you are using and run the commands:

    npm init npm install bower init bower install

  3. The package.json and bower.json files should have the info necessary to run the previous commands. Once everything is installed, run the command "gulp serve" to see the project live..

Known Bugs

There are no known bugs at this time. This app is not fully developed at this point and some functionality is either missing or not clear.

Support and contact details

If you have any questions, concerns, or feedback, please contact the author through gitHub.

Technologies Used

  • This project was built on Node.js.
  • Dependencies were handled with npm and Bower.
  • Gulp is an awesome asset pipeline used in this project.

License

MIT License.

Copyright (c) 2016 Mary Warrington