ai4up / eubucco.com

eubucco

EUBUCCO is a scientific database of individual building footprints for buildings across the 27 European Union countries and Switzerland.

License: MIT

Settings

Moved to settings.

pre-commit

We are using pre-commit to uphold certain formatting standards. Please check out the link to find out how to use/install it on your system.

Basic Commands

Getting Up and Running Locally With Docker

Full Guide can be found here: Getting Up and Running Locally With Docker

Start the server with:

docker compose -f local.yml up

Rebuild the images & Start

docker compose -f local.yml up --build

Setting Up Your Users

• To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a " Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

• To create a superuser account, use this command:

  docker compose -f local.yml run --rm django python manage.py createsuperuser
  

To access the email verification message go to http://localhost:8025/ where Mailhog is running and confirm the email of the user there. A superuser can log into the admin panel without verification but not into the normal site.

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

---

From here on the doc is autogenerated, commands might not work in our instance!

---

Type checks

Running type checks with mypy:

$ mypy eubucco

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with pytest

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation .

Celery

This app comes with Celery.

To run a celery worker:

cd eubucco
celery -A config.celery_app worker -l info

Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.

Email Server

In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server MailHog with a web interface is available as docker container.

Container mailhog will start automatically when you will run all docker containers. Please check cookiecutter-django Docker documentation for more details how to start all containers.

With MailHog running, to view messages that are sent by your application, open your browser and go to http://127.0.0.1:8025

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Docker

See detailed cookiecutter-django Docker documentation .