AlexVKO / repo-search-api

GraphQl API to search public repositories at Github

Repository Search GraphQl

This is a GraphQL API that searches Github API repositories by a provided query. To understand how to build the query read the Github API Documentation

This app uses:

• Ruby version 2.7.4
• Rails 6.1.4
• GraphQL 1.12.17
• HTTParty 0.20

For more details check Gemfile.

This app is watched by SourceLevel, Code Climate and Travis.

How to tun the app

To run this project you need to have Docker and Docker Compose installed. After that just run on your terminal:

docker-compose up

And then visit localhost:300/graphiql

Running the tests

docker-compose run web bundle exec rspec

Future Improvements

• Add pagination do the list of repositories.
• Implement authentication.
• Add a Web UI to the app.
• Improve security with Rack Attack to protect from bad clients. Can be used to prevent brute-force passwords attacks, scrapers and throttling requests from IP addresses for example.
• Scan code to look for security vulnerabilities with Brakeman.
• Add performance monitoring with New Relic or AppSignal.
• Add error and exception monitoring with Airbrake or Sentry.