Git Product home page Git Product logo

profile-gh-indexer's Introduction

Description

  • An API to register and search profiles and then getting some data(scraping) from github

Dependencies

  • Ruby > 2.7
  • Rails >= 6
  • Docker
  • Postgresql(via DOCKER)

Features

  1. Register user
    1. Providing name and a github profile
    2. After a few moments will scrap data from his github profile and fill his corresponding row
  2. Search for registered users(list)
    1. Pagination
    2. Filter by name(looking between name, githubProfile, organization, localization)
  3. Edit profile 5. Request the rescan(1.2)
  4. Delete profile

Missing things/features(backlog)

  • Use something like sidekiq or aws sqs to queue scan requests and prevent bottleneck from thousands of requests
  • Separation of microservices
    1. Scrapping
    2. Queue/background microservice
  • More automated tests and coverage(currently non-existent)
  • Better use of services to provide better readability
  • Improvements on clean code
  • Better use of filters(maybe using scopes on a better way)
  • If page provided is not a profile should delete(or not even create) and provide some error
  • Improve scrapping technique
    • Use more appropriate tags to find the items
  • Use some URL shortener to the github page

Run tests

  1. bundle install
  2. rspec

Run locally

If desired to not use docker and use another, please edit on config/database.yml:21

  1. docker-compose up -d (database)
  2. bundle install
  3. rake db:setup
  4. rails s

Attention

  • config/master.key must be created (EDITOR=vim rails credentials:edit)
  • .env must be created, in case of doubt just clone the current .env.example

profile-gh-indexer's People

Contributors

kelvinsb avatar

Watchers

 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.