Pola pomoże Ci odnaleźć polskie wyroby. Zabierając Polę na zakupy odnajdujesz produkty “z duszą” i wspierasz polską gospodarkę.

Staging server: https://pola-staging.herokuapp.com/

LICENSE: BSD

Aplikacja została przygotowana do pracy w środowisku Docker. Przed pierwszym uruchomieniem musisz spełnić następujące wymagania wstępne:

1. Ty musisz mieć zainstalowane Docker:
   • Dla Linux, uruchom: curl https://get.docker.com | bash
   • Dla Max OS/Windows, skorzystaj z poradnika: [Get docker](https://docs.docker.com/get-docker/)
2. Ty musisz mieć zainstalowane docker-compose:

   • Dla Linux, uruchom:

     sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

   • Dla Mac OS: Docker Desktop i Docker Toolbox zawierają już Docker Compose wraz z innymi aplikacjami Docker, więc użytkownicy nie muszą instalować Docker Compose oddzielnie.

Po wykonaniu tych kroków powiniens przygotować plik z zmiennymi środowiskowymi. Niestety niektóre komponenty wykorzystują prywatne lub komercyjne APi, więc możesz mieć problem z dostępem, ale nie powinno to stanowić w problemu w rozwoju aplikacji. Zmienne sa przechowywaane w pliku .env. Swój zestaw zmiennych możesz stworzyć bazujac na pliku .env.example.

cp .env.example .env

Teraz możesz uruchomić sorodowisko:

docker-compose up

Poczatkowo baza jest pusta, wiec konieczne jest przeprowadzenie migracji:

docker-compose run web migrate

Warto również utworzyć konto administratora w systemie:

docker-compose run web createsuperuser --username admin --email admin@example.org

Uruchomi to komendę interaktywną, która będzie oczekiwać podania hasła od użytkownika. Możę to wyglądać następująco.

$ docker-compose run web createsuperuser --username admin --email admin@example.org
Creating pola-backend_web_run ... done
Checking environment:
postgres:  OK.
Running: /app/manage.py createsuperuser --username admin --email admin@example.org
Password:
Password (again):
Superuser created successfully.

Po utworzeniu konta, ty możęsz się zalogować pod adresem: http://localhost:8080/cms

Jeśli pojawi się prośba o potwierdzenia założenia konta to niezbędny link będzie dostępny w dzienniku aplikacji

web_1       | Content-Type: text/plain; charset="utf-8"
web_1       | MIME-Version: 1.0
web_1       | Content-Transfer-Encoding: 7bit
web_1       | Subject: [example.com] Please Confirm Your E-mail Address
web_1       | From: webmaster@localhost
web_1       | To: admin@example.org
web_1       | Date: Sun, 04 Oct 2020 13:51:42 -0000
web_1       | Message-ID: <160181950227.18.15611522909315616515@17ac4ef38019>
web_1       |
web_1       | Hello from example.com!
web_1       |
web_1       | You're receiving this e-mail because user admin has given yours as an e-mail address to connect their account.
web_1       |
web_1       | To confirm this is correct, go to http://localhost:8080/accounts/confirm-email/MQ:1kP4QQ:okaOy8Z-KcMpSD0xSGgxPLFA2b0/
web_1       |
web_1       | Thank you from example.com!
web_1       | example.com
web_1       | -------------------------------------------------------------------------------

Aplikacja w dużym stopniu polegają na zmiennych środowiskowych. Został pomyślnie wdrożony zarówno z Gunicorn.

Na potrzeby konfiguracji poniższa tabela odwzorowuje zmienne środowiskowe na ich ustawienia w Django:

W poniższej tabeli wymieniono ustawienia i ich wartości domyślne dla aplikacji innych firm:

Możliwe jest wdrożenie aplikacji na platformę Heroku lub inną platformę wspierające obrazy OCI/Docker.

W celu zbudowania obrazu produkcyjny, ty możesz uruchomić komendę:

./scripts/prod-docker-image.sh

To powinno zbudować obraz docker.pkg.github.com/klubjagiellonski/pola-backend/pola-backend:latest, który możnaa wykorzystać do wdorżenia na inną platfomre.

Uruchom następujące polecenia, aby wdrożyć projekt w Heroku z wykorzystaniem obrazu Docker:

heroku addons:create heroku-postgresql:hobby-dev
heroku pg:backups schedule --at '02:00 America/Los_Angeles' DATABASE_URL
heroku pg:promote DATABASE_URL

heroku addons:create heroku-redis:hobby-dev
heroku addons:create mailgun

heroku config:set DJANGO_SECRET_KEY=$(openssl rand -base64 32)
heroku config:set DJANGO_SETTINGS_MODULE='pola.config.settings.production'

heroku config:set DJANGO_AWS_ACCESS_KEY_ID=YOUR_AWS_ID_HERE
heroku config:set DJANGO_AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY_HERE
heroku config:set DJANGO_AWS_STORAGE_BUCKET_NAME=YOUR_AWS_S3_BUCKET_NAME_HERE

heroku config:set DJANGO_MAILGUN_SERVER_NAME=YOUR_MALGUN_SERVER
heroku config:set DJANGO_MAILGUN_API_KEY=YOUR_MAILGUN_API_KEY

heroku config:set PYTHONHASHSEED=random

./scripts/prod-docker-image.sh
./scripts/deploy.sh

heroku run python manage.py migrate
heroku run python manage.py check --deploy
heroku run python manage.py createsuperuser
heroku open