filipsyn / mojesberna

Moje Sběrna

About

Web application for managing recycling center.

Development setup

Prerequisites

• Git
• Docker
• Preferably UNIX-based operating system or Windows Subsystem for Linux, because some things are written with UNIX in mind.

Using GNU/Make (optional)

If you have GNU/Make installed on your system (usually can be found on UNIX-based systems or in WSL), you can use prepared scripts listed in Makefile.

# Installs the project
make install 

# Runs docker container and development server
make on

Be sure to check out Makefile for other useful scripts to use when developing.

Manually for Unix-based systems (Linux, MacOS, ...)

Set environmental variables

export FLASK_APP='src/app.py'
cp .example.env .env

Create and set-up virtual environment

python -m venv venv
source venv/bin/activate
pip install -r src/requirements.txt

Spin up docker database image

docker-compose up -d

Prepare database

flask prepare-database

After that, everything is ready to go. You can run application with:

flask run --port 8080 --host 0.0.0.0

Manually for Windows (PowerShell)

Set environmental variables

$env:FLASK_APP = 'src/app.py'
Copy-Item .example.env .env

Create and set-up virtual environment

python -m venv venv
.\venv\Scripts\Activate.ps1
pip install -r src/requirements.txt

Spin up docker database image

docker-compose up -d

Prepare database

flask prepare-database

After that, everything is ready to go. You can run application with:

flask run --port 8080 --host 0.0.0.0

Development guidelines

Here you can read more about some code guidelines.

Used technologies

• Python
• Flask
• SQLAlchemy
• Docker
• PostgreSQL
• HTML
• CSS