https://flask.palletsprojects.com/en/1.1.x/tutorial/views/

Since Python has complex package handling procedure we provide manual installation of main library components because of pip locks dependancies as well (Which breaks things in future when pypi update dependancies for main libraries). In this repository requirements.txt file is provided. If something breaks years from now please ignore requirements.txt file and follow the manual procedure below.

Here we specify all the main components used to develop the project so when an installation happens all compatible dependancies will also get updated automatically.

pip install Flask==3.0.0            # Upgraded
pip install alembic==1.13.1         # Upgraded
pip install python-dotenv==0.10.3
pip install colored==1.4.2
pip install psycopg2==2.9.9         # Upgraded
pip install uwsgi==2.0.23           # Upgraded

Configure database credentials in .env file

DATA_SOURCE=postgres://flask_user:[email protected]:5432/flask_skel

Propergate the latest database using alembic (https://alembic.sqlalchemy.org/en/latest/tutorial.html)

alembic check
alembic upgrade head

Setup frontend JS/CSS UI components

# Install LTS version of nodejs (At the time of writing this 20)
npm install
npm run build-css

The above command build-css will generate required css files based on scss templates residing within src/public/scss directory.

# Run below script
./server.py

Scripts in this directory should be used to manage the skeleton. upgrade_assets.sh - This is the script which is used to upgrade all the assets (javascripts, css, semantic UI) This script must find it's base directory by using realpath. Then this script should find public assets directory Next Download required packages -> build -> deploy. public - Publicly sharable documents (minified css and js. Images) public-src - Source files which are later converted into minified css and js

In order to keep current program live we have to keep some columns if we are going to remove them in the database updating stage. Because current program will not work if we suddenly make database changes. For errorless strategy we recommend first create a separate nullable column (If we are going to change colum name) and then develop your application using that column name ignoring previous name the column had. Secondly copy none-existing data to the new column and quickly start new code.

In the frontend we map /static directory to src/public

1. First create a virtual environment inside the directory using the command virtualenv venv.
2. Activate the environment using . ./venv/bin/activate and install the packages using pip install -r requirements.txt.
3. Run alembic upgrade head to update the database schema changes in the database.
4. run.sh is the main shell script responsible for running the application. In that script uwsgi program is running an application instance or instances inside the file server.py using the settings inside uwsgi.ini.
5. User ownerships in uwsgi.ini must be change accordingly in order to be easily communicate with nginx or apache web server.
6. scripts/flask_skeleton.service systemd unit file can be used to start the application on system reboots. All you have to do is change the configurations, path names and ownerships in that file.
7. Change the ownership of entire directory to the user specified in uwsgi.ini or scripts/flask_skeleton.service.
8. If systemd unit file rejects the execution of uwsgi, You can set all the uwsgi configurations inside that systemd unit file.
9. As a security strategy please send nginx or apache request ID in the header X-Request-Id to the upstream backend.