An application for storing and managing links online.

Status

This application is currently available here

Running it locally

Ooh boy here we go.

First of all you need Python 3.x Then, go ahead and install PIP. Instructions for its installation are available here

To make sure all the depedencies are installed run:

pip install -r requirements.txt

Next, you must have a PostgreSQL database created. For that you can use PG Admin.

You will then have to create a config.json file which has the following structure:

{
    "DB":{
        "USER": <DB_USER>,
        "PWD": <DB_PASSWORD>,
        "HOST": <DB_HOST>,
        "DATABASE": <DB_NAME>,
        "PORT": <DB_PORT>
    },
    "SECRET_KEY": <your_scecret_key>,
    "MAIL_SERVER":"smtp.gmail.com",
    "MAIL_PORT":465,
    "MAIL_USE_TLS":false,
    "MAIL_USE_SSL":true,
    "MAIL_USERNAME": <EM_USER>,
    "MAIL_PASSWORD": <EM_PASSWORD>,
    "MAIL_DEFAULT_SENDER": <EM_USER>
}

• The MAIL settings/fields are necessary for the password recovery process, if you don't plant on using the feature you can remove them.

• The specified MAIL_SERVER and MAIL_PORT are for use with a GMAIL address.

• The MAIL_DEFAULT_SENDER property can be removed but then you will have to specify the sender when building a Message

---

Since the project's file structure has changed, a simple

python __init__.py

will not suffice.

Running the app with docker-compose

It's heavily encouraged to run the project locally using docker-compose. Simply running docker-compose up should suffice. Afterwards, you should be able to access the site on localhost:5000.

Running the app with flask

First you need to set the environment variable for the application.

One way to do this is :

From /3RStore

On linux:

export FLASK_APP=_3RStore/__init__.py

On windows:

set FLASK_APP=_3RStore/__init__.py

Then (from this directory) simply run :

flask run

to launch the server. A prompt indicating sucessfull launch should appear in the console.

If you want to set Flask's debug mode on you can use:

export FLASK_DEBUG=true

And

set FLASK_DEBUG=true

For Linux and Windows respectively.

Finally, you can open your browser and go to

http://127.0.0.1:5000/

If you get an error regarding the build environment, set/export the FLAK_ENV variable to whatever you please

---

Running the app with waitress

First run

python server.py

Then go to

http://127.0.0.1:8080/

Ta-da!