ES Gitlab Scraper

This is a scraper which collects data from an specific GitLab account with the goal of giving out reports about what students have done and even qualifying of their practices in a short time.

How to run the scraper

1. First, you have to install Node.js and npm on your system.

2. Then you can install es-gitlab-scraper by running following command:

   sudo npm install -g es-gitlab-scraper

3. After installing the app, you can simply run it by running:

   es-gitlab-scraper

4. If you're running es-gitlab-scraper for the first time, you'll be asked for entering your API token. you can create it here if you haven't already had it.

How to use

There are different options to use:

• Show a Full Table Report

  Shows a full table report of student names, their weekly projects and challenges.

• Which projects are empty?

  Gives a report about empty projects (no week practices and no challenges.)

• Who didn't do any challenge?

  Gives a report about projects which not include challenge within.

• Show students and their projects

  Shows a table of students, and the links to their repositories

• Export report to CSV

  Exports all analyzed data into a CSV file

• Re-assign access token

  Re-assigns a new token if you've changed if in your Gitlab account. This may be used for security reasons from administrators.

• Re-store All Projects

  Crawls and scraps all projects data again, and store them into app's local DB.