• Install python 3.6 or above
• Clone/download this repository and navigate to this repo through cmd

$ git clone https://github.com/hemanta212/nepali-news-portal-kbd

• Install either poetry or follow this guide for setting up virtual environment.
• Installing dependencies using poetry

$ poetry install

• Installing dependencies using pip.

$ python -m pip install -r requirements.txt

Setting up Database

You can setup any database supported here. This doc covers setting up sqlite and postgres db.

Setting up SQLite

Populate the following as your environment variables

SECRET_KEY="<your secret key here (random string sequence)"
SQLALCHEMY_DATABASE_URI="sqlite:///site.db"
MAIL_USERNAME="your email",  //optional
MAIL_PASSWORD="your password" //optional

NOTE

• optional: only required for 'forgot/reset password' functionality to work If you use gmail and 2 factor-auth, you can use app passwords without compromising to low security.

• To enable the international news section get an api key from News API and set environment variable 'NEWS_API_KEY' to that value.

Alternatively, you can populate these detail in 'template_secrets.json' file and rename it to secrets.json.

Setting up the Postgres Databse

The details of installing, configuring a postgres database is detailed here.

Once you have setup the db and have its URI, just set it as the value of 'SQLALCHEMY_DATABASE_URI' in above SQLite section and continue following this doc.

Initializing the database

To upgrade the newly created database to the project's structure use

$ python manage.py db upgrade

Similarly, if you need to start fresh, delete the migrations folder and now run,

$ python manage.py db init # create the migrations folder
$ python manage.py db migrate # create sql commands for the required db construction
$ python manage.py db upgrade # executes those changes in the db

KNOWN ISSUE

• While Using SQLite relative URI: Due to the mismatch in the folder level of manage.py and flask application only the sqlite:///site.db relative URI is supported other relative URIs wont work so consider using absolute sqlite URIs.

Running the Server

    python run.py // production environment (default)
    python run.py debug // for debug environment

NOTE: Running in Prod mode is unsupported with secrets.json file and will fallback to Debug.

Running from gunicorn (Not supported on windows) <a id='gunicorn'></a>

Gunicorn is a production WSGI server that is essential for running flask project in production environments like with Procfile in Heroku.

After installing, you just provide the application instance of project to gunicorn.

eg.

gunicorn run:app  // prod env

gunicorn run:app debug

NOTE:

Gunicorn is not supported in windows operating system. However, you can run it using WSL.