Geoflask

This project fully placed in Docker.

There are two ways to setup environment and run application via Docker:

1. Visual Studio Code Remote - open project in VS Code.

2. Build manually from shell on any machine with docker.

📌 Requirements

• Docker.

🔧 Setup

0. Install remote-containers Visual Studio Code extensions.

   > code --install-extension ms-vscode-remote.remote-containers

1. Clone this repo to your machine.

   > git clone [email protected]:andrejreznik/geoflask.git

2. Open Visual Studio Code in geoflask folder:

   > cd geoflask
   > code .

   or build manually (skip if using VS Code).

   > cd geoflask
   > docker-compose build .

3. Prepare database:

   > export FLASK_APP=geoflask/web/commands.py
   > flask create-db
   > flask seed-db

🚀 Run application

1. To start Flask server you need to start process in terminal:

   > export FLASK_APP=geoflask/web/app.py
   > flask run

   or simply launch application by click on Run -> Run Without Debugging Ctrl + F5,

   or via docker-compose command:

   > docker-compose exec -e FLASK_APP=geoflask/web/app.py web python run

📚 Libraries

• Flask - micro web framework.
• GeoAlchemy2 - geospatial extension to SQLAlchemy.
• Flask-SQLAlchemy - extension for Flask that adds support for SQLAlchemy.
• Flask-Migrate - database migrations.
• psycopg2 - PostgreSQL Database Adapter.
• uWSGI - web server.
• flake8 - linter and formatter.

⚖️ Licensing

See: LICENSE (MIT).