README.md

GitHub Profiler Repository

Setup Procedures

1. Create a .env file at the root of your working directory that also hosts the Dockerfile.

2. Populate the .env file as follows:

   FLASK_APP=web.app.py
   FLASK_DEBUG=True
   FLASK_HOST=127.0.0.1:8080
   FLASK_RUN_PORT=8080
   GITHUB_TOKEN=<your_github_personal_access_token>
   DB_NAME=github_profiler.db
   TEST_DB_NAME=test_github_profiler.db
   

3. Build the Docker image with the following command:

   docker build -t github-profiler .

4. Create and run the Docker container with the following command:

   docker run -dp --rm --env-file ./.env github-profiler