ChannelX

This project is created for the Software Engineering course of Istanbul Technical University.

Project Members

• 150140119 Muhammed Kadir Yucel
• 040140003 Burak Mert Gonultas
• 150140021 Utku Oner
• 150140034 Kubilay Yazoglu
• 150140013 Murat Ozkok

How to Install Locally?

Make sure you have installed

• PostgreSQL 10
• Python 3.x
• Flask - pip install Flask

You can install required additions from "requirements.txt" by executing following command:

pip install -r requirements.txt

Make sure you have follow requirements before running for debug purposes

• PostgreSQL channelx named database created

Make sure you have added required environmental variables to your system for local debug:

• Variable required for mail sending;

  Name: CHANNELX_MAIL_PASS Variable: ask for mail password

• Variable required for SQL server: Name: CHANNELX_SQL_SERVER Variable: postgresql://adminusername:adminpassword@localhost/channelx

• Variable required for mail redirecting; Name: GAW_APPLICATION_NAME Variable: e-mail-okuma

• Variable required for mail redirecting; Name: GAW_CLIENT_SECRET_FILE_PATH Variable: C:\Users\Root\Desktop\channelx\client_secret.json(write your path)

• Variable required for mail redirecting; Name: GAW_DISABLE_SSL_CERTS Variable: True

• Variable required for mail redirecting; Name: GAW_SCOPES Variable: https://mail.google.com/

• Variable required for mail redirecting; Name: GAW_USER_ID Variable: untitledchannelx@gmail.com

Before running project, this needs to be executed if models.py is changed, i.e. new tables added

• Open terminal or command prompt inside project folder

• Open Python program by writing 'python'

  from app import db db.create_all()

Windows Systems

https://www.youtube.com/watch?v=XC_esREQyzQ

Open project folder in command prompt

set FLASK_APP=app.py
flask run

Unix-like Systems

Linux and Max OS systems are examples of Unix-like systems. Open terminal inside project folder

export FLASK_APP=app.py
flask run

How to Test?

tests/ directory contains functional and load tests. For further information look inside this directory.

Unit tests

Unit tests are implemented with Python 3's unittest library, there are 23 tests in total. You can use following command to start testing

$ python3 channelx_unittest.py