FLASK-CONTACTS-DEVOPS

Project Name

A brief description of the project, what it does, and its main features.

Table of Contents

• Use
• Installation
• Screenshots
• License
• Contact

Flask contacts

Use

• Flask (Obvious!)
• Flask-SQLAlchemy (ORM for database)
• Flask-WTF (Generation of forms and validations)
• Faker (Generates fake data)

installation

Python installation(Debian/Ubuntu)

sudo apt update
sudo apt install python3
sudo apt install python3-pip
sudo apt install python3-venv

.venv creation (Optional)

python3 -m venv .venv
source .venv/bin/activate

Install dependencies

pip3 install -r requirements.txt

Run

environment variables

This project requires the following environment variables to be set: Create a .env file in the root of your project and add the following lines:

Required Variables:

• DB_HOST= The hostname of your MySQL database. default localhost
• DB_USER= The username for your MySQL database. default root
• DB_PASSWORD= The password for your MySQL database. default admin
• DB_NAME= The name of your MySQL database. default contacts_app
• DATABASE_TYPE= MYSQL or MONGO. default MYSQL
• DB_PORT= The port of your MySQL database. default 3306

Optional Variables

• OPENAI_API_KEY= Your OpenAI API key. Obtain this from the OpenAI API settings page.
• MONGO_URI= in case you are using mongodb default - mongodb://localhost:27017/

Set environment variables by script (Linux optional)

export OPENAI_API_KEY=your_openai_api_key
export DB_HOST=your_database_host
export DB_USER=your_database_user
export DB_PASSWORD=your_database_password
export DB_NAME=your_database_name
export DEBUG=false

For MYSQL RUN Migration

python3 migrate.py

python3 app.py

Access the application :

application should be available at port 5052 Route examples:

• http://localhost:5052/
• http://127.0.0.1:5052/viewContacts
• http://127.0.0.1:5052/editContact/{id}
• http://127.0.0.1:5052/addContact/

Screenshots

License

some license example

Contact

contact Arja Stark from Winterfell ```