DigiRamp flask application

Table of Content 🔎

• Introduction
• Environment
• Installation
• Technologies
• Usage
• License

Introduction 📃

DigiRamp is a web application written in flask micro-framework. It is a solution for airline companies that offers leaner communication across multiple departments while preparing the aircraft for the next flight.

To use a demo of the app click here

Disclaimer ❗

do not use any real information(emails-password on the demo)!! the app is still in development and lacks security testing.

Authors ✏️

Ahlem kaabi linked-in

Environment 🔧

This project is interpreted/tested on Ubuntu 20.04 LTS using python3 (version 3.8.10) and MySql ( Ver 8.0.26-0ubuntu0.20.04.2 )

Installation 📥

This guide will help you to start using the web application in your local environment

Requirements:

- Python >= 3.8.10
- pip
- MySql ( Ver 8.0.26-0ubuntu0.20.04.2 )

Steps:

Setup the database:

1. create a database Your_db_Name.

   CREATE DATABASE Your_db_Name;
   

2. create a user User_Name with password Your_password.

   CREATE USER 'User_Name'@'localhost' IDENTIFIED BY 'Your_password';
   

3. for User_Name grant all privileges on the Your_db_Name database.

   GRANT ALL PRIVILEGES ON Your_db_Name . * TO 'User_Name'@'localhost';
   

Get the code base

1. clone the repository on your computer
2. pip install -r requirements.txt
3. inside the project directory create instance/config.py file

We will put configuration variables here that will not be pushed to version control due to their sensitive nature. In this case, we put the secret key as well as the database URI which contains the database.

# instance/config.py

SECRET_KEY = '<^>YOUR_SECRET_KEY^>'
SQLALCHEMY_DATABASE_URI = 'mysql+pymysql://User_Name:Your_password@localhost/Your_db_Name'

4. run these commands:

$ flask db init
$ flask db migrate
$ flask db upgrade

5. final step

$ export FLASK_CONFIG=development
$ export FLASK_APP=run.py
$ flask run

Technologies 💻

Usage ✈️

Add New flight

Supervise a flight turnaround processes:

Upload and display required informations:

Display data tables - Operated flight:

Display airports IATA Codes:

License 🔒

This project is licensed under the MIT License see MIT LICENSE file for more details

Final word ✒️

This project was written as part of the curriculum for Holberton School. Holberton School's methodology uses project-based learning and peer-learning to teach students the theory and tools needed to adapt to the future and ever-changing technologies. For more information, visit this link.