FOSDEM / volunteers

Volunteers management system for the FOSDEM conference
GNU Affero General Public License v3.0
19 stars 24 forks source link

Readme appears to be outdated #54

Open ChristopherHackett opened 1 year ago

ChristopherHackett commented 1 year ago

I've been taking a look at this project and the development setup steps in the readme seem to be incomplete or outdated.

  1. It says "By default this uses a sqlite3 database." however the file to copy has postgress configured. localsettings_example.py
    
    # Database config
    # When on heroku
    if 'dj_database_url' in locals() and dj_database_url.config():
    DATABASES = {}
    DATABASES['default'] = dj_database_url.config()
    # When on localhost
    else:
    DATABASES = {
        'default': {
            # 'django.db.backends.' +  'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
            'ENGINE': 'django.db.backends.postgresql_psycopg2',
            # Or path to database file if using sqlite3.
            'NAME': 'volunteers',

2. On checkout the folder './logs/` does not exist and as a result `/manage.py migrate` runs into an error until it has been created

FileNotFoundError: [Errno 2] No such file or directory: '/Users/chackett/dev/code/oss/volunteers/logs/error.log'


3. Not a problem with setup instructions but a problem encountered is needing to bump xhtml2pdf from 0.2.5 to 0.2.6 to resolve reportlab compatibility issue 

ImportError: cannot import name 'getStringIO' from 'reportlab.lib.utils' (/Users/chackett/dev/code/oss/volunteers/.venv/lib/python3.10/site-packages/reportlab/lib/utils.py)


4. The getting started says to `pip install -r requirements.txt` but it seems the dev requirements should be used `pip install -r requirements-dev.txt`

5. When getting to `./manage.py migrate` the following error is encountered 

./manage.py migrate SystemCheckError: System check identified some issues:

ERRORS: <class 'volunteers.admin.VolunteerTaskAdmin'>: (admin.E108) The value of 'list_display[0]' refers to 'volunteeruserusername', which is not a callable, an attribute of 'VolunteerTaskAdmin', or an attribute or method on 'volunteers.VolunteerTask'. <class 'volunteers.admin.VolunteerTaskAdmin'>: (admin.E108) The value of 'list_display[1]' refers to 'task__name', which is not a callable, an attribute of 'VolunteerTaskAdmin', or an attribute or method on 'volunteers.VolunteerTask'.



As well as the individual issues above I'm not sure if this is the current dev setup as there is a CI folder with a Dockerfile etc.  At this point I'm not going to go further as I might be going down the wrong path.
piemonkey commented 1 year ago

I just saw this. My PR #57 fixes just this :)

I didn't get the errors in 5. though, maybe they've been fixed already?