PerForge

Build PerForge-app docker image and push it to Docker Hub

👉 Step #1 - Log in to the Docker Hub on your local machine

$ docker login

👉 Step #2 - From the root folder run the following command to build the Docker image and tag it

$ docker build -t perforge/perforge-app:TAG . or docker buildx build -t perforge/perforge-app:TAG

👉 Step #3 - Push it to Docker Hub

$ docker push perforge/perforge-app:TAG

Build Perforge-grafana docker image and push it to Docker Hub

👉 Step #1 - Log in to the Docker Hub on your local machine

$ docker login

👉 Step #2 - From the ./grafana_build folder run the following command to build the Docker image and tag it

$ docker build -t perforge/perforge-grafana:TAG .

👉 Step #3 - Push it to Docker Hub

$ docker push perforge/perforge-grafana:TAG

Build from sources

👉 Step #1 - Clone sources (this repo)

$ git clone 
$ cd reporter

👉 Step #2 - Create a virtual environment

$ # Virtualenv modules installation (Unix based systems)
$ virtualenv env
$ source env/bin/activate
$
$ # Virtualenv modules installation (Windows based systems)
$ # pip install virtualenv
$ # virtualenv env
$ # .\env\Scripts\activate

👉 Step #3 - Install dependencies

$ # Install requirements
$ pip3 install -r requirements.txt

👉 Step #4 - Set Up Environment

$ # Set the FLASK_APP environment variable
$ (Unix/Mac) export FLASK_APP=run.py
$ (Windows) set FLASK_APP=run.py
$ (Powershell) $env:FLASK_APP = ".\run.py"

👉 Step #5 - Create Tables (SQLite persistance)

$ # Create tables
$ flask shell
$ >>> from app import db
$ >>> db.create_all()

👉 Step #6 - (optional) Enable DEBUG Environment (local development)

$ # Set up the DEBUG environment
$ # (Unix/Mac) export FLASK_ENV=development
$ # (Windows) set FLASK_ENV=development
$ # (Powershell) $env:FLASK_ENV = "development"

👉 Step #7 - Start the project

$ # Run the application
$ # --host=0.0.0.0 - expose the app on all network interfaces (default 127.0.0.1)
$ # --port=5000    - specify the app port (default 5000)  
$ flask run --host=0.0.0.0 --port=5000
$
$ # Access the app in browser: http://127.0.0.1:5000/

Code-base structure

The project has a super simple structure, represented as bellow:

< PROJECT ROOT >
   |
   |-- app/
   |    |-- integrations/
   |    |--  |-- influxdb                        # Configuration files with data for connecting the tool to influxdb, grafana, etc.
   |    |--  |-- grafana
   |    |--  |-- azure
   |    |-- reports/
   |    |--  |-- <config files, JSON, YAML>      # Configuration files for reports
   |    |-- static/
   |    |    |-- <css, JS, images>               # CSS files, Javascripts files
   |    |
   |    |-- templates/
   |    |    |
   |    |    |-- index.html                      # Index File
   |    |    |-- login.html                      # Login Page
   |    |    |-- register.html                   # Registration Page
   |    |-- tools/
   |    |    |
   |    |    |-- tools.py                        # Custom python lib with functions
   |    |    
   |    |
   |   config.py                                 # Provides APP Configuration 
   |   forms.py                                  # Defines Forms (login, register) 
   |   models.py                                 # Defines app models 
   |   views.py                                  # Application Routes 
   |
   |-- requirements.txt
   |-- run.py
   |
   |-- ************************************************************************