https://github.com/tsimpdim/3rstore

A Python Flask application used to store links online.
https://github.com/tsimpdim/3rstore

bootstrap flask flask-application html javascript jinja2 postgresql python wtforms

Last synced: about 24 hours ago
JSON representation

A Python Flask application used to store links online.

• Host: GitHub
• URL: https://github.com/tsimpdim/3rstore
• Owner: TsimpDim
• Created: 2017-11-27T09:34:45.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-27T15:33:45.000Z (almost 2 years ago)
• Last Synced: 2023-02-28T04:11:29.970Z (over 1 year ago)
• Topics: bootstrap, flask, flask-application, html, javascript, jinja2, postgresql, python, wtforms
• Language: Python
• Size: 742 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        


An application for storing and managing links online.

## Status

This application is currently available [here](http://threerstore.herokuapp.com)

## Running it locally

Ooh boy here we go.

First of all you need [Python 3.x](https://www.python.org/downloads/)

Then, go ahead and install PIP. Instructions for its installation are available [here](https://pip.pypa.io/en/stable/installing/)

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](https://www.pgadmin.org/).

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

```

{

    "DB":{

        "USER": ,

        "PWD": ,

        "HOST": ,

        "DATABASE": ,

        "PORT": 

    },

    "SECRET_KEY": ,

    "MAIL_SERVER":"smtp.gmail.com",

    "MAIL_PORT":465,

    "MAIL_USE_TLS":false,

    "MAIL_USE_SSL":true,

    "MAIL_USERNAME": ,

    "MAIL_PASSWORD": ,

    "MAIL_DEFAULT_SENDER": 

}

```

- 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!