- An API to register and search profiles and then getting some data(scraping) from github
- Ruby > 2.7
- Rails >= 6
- Docker
- Postgresql(via DOCKER)
- Register user
- Providing name and a github profile
- After a few moments will scrap data from his github profile and fill his corresponding row
- Search for registered users(list)
- Pagination
- Filter by name(looking between
name
,githubProfile
,organization
,localization
)
- Edit profile 5. Request the rescan(1.2)
- Delete profile
- Use something like
sidekiq
oraws sqs
to queue scan requests and prevent bottleneck from thousands of requests - Separation of microservices
- Scrapping
- 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
bundle install
rspec
If desired to not use docker and use another, please edit on config/database.yml:21
docker-compose up -d
(database)bundle install
rake db:setup
rails s
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