README.md

Unify Events - Calendar of Events and Activities at the University of Central Florida and Orlando, FL

Installation and Setup

1. Install Open-LDAP development headers (debian: openldap-dev, rhel: openldap-devel)

• via Homebrew: brew install openldap

2. Create virtual environment and cd to it

    python3 -m venv ENV
    cd ENV
   

3. Clone repo to a subdirectory (ex. git clone REPO_URL src)

4. Activate virtual environment

    source bin/activate
   

5. cd to new src directory and install requirements

    cd src
    pip install -r requirements.txt
   

   NOTE: if pip install returns a block of error text including fatal error: 'sasl.h' file not found upon installing python-ldap, do the following:

   1. In requirements.txt, comment out the python-ldap requirement.

   2. Re-run pip install -r requirements.txt. It should complete successfully.

   3. Run the following, replacing "VERSION" with the version number specified for the python-ldap package in requirements.txt:

       pip install python-ldap==VERSION \
       --global-option=build_ext \
       --global-option="-I$(xcrun --show-sdk-path)/usr/include/sasl"
      

   4. Un-comment the python-ldap requirement in requirements.txt and save the file.

6. Set up local settings using the settings_local.templ.py file

7. Set up static_files/static/robots.txt using static_files/static/robots.templ.txt

8. Run the deployment command: python manage.py deploy. This runs any migrations and collects the static files.

9. Create a superuser: python manage.py createsuperuser

10. If you don't intend on importing any existing calendar data, create a Main Calendar and assign your superuser account as the owner. Otherwise, skip this step