mateusluizfb / crawley-ex

An elixir app that fetches repos across the Github catalog
4 stars 2 forks source link

Hex pm CircleCI


Crawley

Crawley is an elixir package that scraps the Github API searching for repos to download and then zip and upload them to a S3 bucket.

Before you run anything, remember to create an .env file like this:

export GITHUB_TOKEN=""
export AWS_ACCESS_KEY_ID=""
export AWS_SECRET_ACCESS_KEY=""
export USE_LOCAL_STORAGE=true/false

The GITHUB_TOKEN var is your github token.


To run:

  1. iex -S mix
  2. Crawley.run(%{lang: lang, per_page: per_page, page: page})

To contribute:

  1. Fork the project
  2. Make that changes you want
  3. Create the PR to the repo
  4. Await the review :)