Information system for homeowners' associations (SVJ). 🏡
SVJIS is a CMS for Homeowners' Associations. The system provides a content management system 📝, discussions under articles, polls 📊, reporting and tracking of issues, advertisements, and a database of owners 👨👩👦 including records of units and shares. More on the project website.
It is assumed that you have Python version 3.10 or higher installed on your computer.
python --version
Clone the project
git clone https://github.com/svjis/svjis2.git
cd svjis2
Create a virtual environment and switch to it
python -m venv venv
# in Linuxu
source venv/bin/activate
# in Windows
source venv/Scripts/activate
Install the dependencies and create the configuration
pip install -r requirements.txt
cd svjis
python manage.py migrate
python manage.py svjis_setup --password <password for admin user>
Note
To compile the translations, you will need to have the gettext utility installed - try gettext --version. If you don't have it, feel free to skip the next step, and the application will only be available in English.
python manage.py compilemessages
python manage.py runserver
The application runs at the address http://127.0.0.1:8000/ with the user admin and the password is the one you entered earlier.
The method of starting mentioned is suitable for quickly testing the application on your computer or for developers. If you want to deploy SVJIS on a production server, please read the Django documentation.
On the project pages, you will find a step-by-step example of installation on a server (Debian, Apache, Postgres).
The settings for SVJ data can be found in the application under the Administration section.
The SVJIS system uses email sending for various events, so the correct configuration of the email interface is essential for the application's functionality.
Create a new file svjis/svjis/local_settings.py and add the following configuration:
SECRET_KEY = 'production django secret'
TIME_ZONE = 'Europe/Prague'
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = 'your smtp server'
EMAIL_USE_TLS = False
EMAIL_USE_SSL = True
EMAIL_PORT = 465
EMAIL_HOST_USER = 'username to your smtp server'
EMAIL_HOST_PASSWORD = 'password to your smtp server'
Email sending occurs in the background - the system stores emails in a queue for sending, see Administration - pending messages. To send messages, you need to run the following command:
python manage.py svjis_send_messages
During application testing, you can run it manually. In a production setup, you need to configure a system scheduler (like cron) to run it at certain intervals (for example, every 5 minutes).
If you encounter any issues, do not hesitate to ask a question in the project discussions.
Any form of collaboration is welcome. 
More information can be found in CONTRIBUTING.md.