Giter Club home page Giter Club logo

github-searcher's Introduction

Github Searcher

This is a web app that searches for github repos based on repo names or by user name (option is given as a select tag). It uses http://piotrmurach.github.io/github/ for Github API calls.

Running the app:

You need to have an .env file in the root directory with the following two fields:
LOGIN="<your-github-login>"
PASSWORD="<your-password>"

These fields are being used in the config/application.rb file. We've defined constants such as PER_PAGE for pagination in a file called config/initializers/constant.rb.

Details:

All the application code involving Github API is in app/controllers/github_interface_controller.rb. Pagination is done natively by the used gem, however some logic was involved when it came to rendering it on the page which could be seen in app/views/github_interface/index.html.erb and the helper app/helpers/application_helper.rb.

There is no database since we don't need to persist anything and so no need of running migrations.

Bootstrap is used for some styling.

Tests:

Tests can be run from the root application directory by running: rspec

Test Coverage:

Test coverage is done using simplecov. The output of simplecov is an HTML file named index.html that goes inside coverage folder.

Currently, the coverage is 85.71%.

Testing could further be expanded to cover more cases.

github-searcher's People

Contributors

minaamfasihi avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.