Merge pull request #922 from zhe-CUNY/main

Docker-compose, allauth.google as temp fix, and geo.js

Author: zhe-CUNY

.env.example

@@ -0,0 +1,47 @@
+DISTR_DB_NAME=representable_db
+DISTR_DB_USER=representable
+DISTR_DB_PASS=password
+DISTR_DB_HOST=db
+#DATABASE_URL=
+
+SECRET_KEY=django-insecure-key-1234
+DJANGO_SETTINGS_MODULE=representable.settings.dev
+
+DISTR_MAPBOX_KEY=
+MAPBOX_USER_NAME=
+
+# used for Signature model (hashes CommunityEntry submission)
+AUDIT_SECRET=long_line_of_text
+
+# https://docs.allauth.org/en/latest/socialaccount/providers/google.html#google
+# Make sure to include the app's url in Clients > OAuth 2.0 Client IDs > Authorized redirect URIs
+GOOGLE_OAUTH_CLIENT_ID=
+GOOGLE_OAUTH_SECRET=
+
+# https://www.google.com/recaptcha/admin
+# data-sitekey and api key
+RECAPTCHA_PUBLIC=
+RECAPTCHA_PRIVATE=
+
+# https://www.perspectiveapi.com/
+# 
+PERSPECTIVE_API_KEY=
+
+
+# used for s3 bucket storage for geojsons of user submissions
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_STORAGE_BUCKET_NAME=representable
+
+# email smtp (current using sendgrid to switch over to mailgun)
+SENDGRID_API_KEY=
+SENDGRID_USERNAME=
+SENDGRID_PASSWORD=
+
+MAILGUN_DOMAIN=
+MAILGUN_API_KEY=
+MAILGUN_PUBLIC_KEY=
+MAILGUN_SMTP_LOGIN=
+MAILGUN_SMTP_PASSWORD=
+MAILGUN_SMTP_PORT=587
+MAILGUN_SMTP_SERVER=smtp.mailgun.org

.gitignore

@@ -142,4 +142,7 @@ google_token.json
 # Translation text outputs
 *translations.txt
 *untranslated.txt
-*tanslation.txt
+*tanslation.txt
+
+# Docker 
+pg_data/

Dockerfile

@@ -0,0 +1,26 @@
+FROM python:3.9.23-slim
+
+WORKDIR /app
+
+RUN apt-get update
+
+RUN apt-get install -y libpq-dev postgresql-client python3-dev \
+    gdal-bin libgdal-dev python3-gdal\
+    make build-essential libssl-dev zlib1g-dev \
+    libbz2-dev libreadline-dev libsqlite3-dev \
+    llvm libncurses5-dev libncursesw5-dev xz-utils \
+    tk-dev libffi-dev liblzma-dev \
+     --no-install-recommends && \
+    apt-get clean -y
+
+# Set GDAL/GEOS library paths
+ENV GDAL_LIBRARY_PATH=/lib/x86_64-linux-gnu/libgdal.so.36
+ENV GEOS_LIBRARY_PATH=/lib/x86_64-linux-gnu/libgeos_c.so.1
+ENV LD_LIBRARY_PATH=/lib/x86_64-linux-gnu:$LD_LIBRARY_PATH
+
+RUN pip install --upgrade pip
+
+COPY ./requirements.txt /app/requirements.txt
+RUN pip install -r requirements.txt
+
+ENTRYPOINT ["bash"]

README.md

@@ -7,6 +7,27 @@ Representable is creating maps of communities to fight for equal and impartial r
 ### Documentation
 Check out our [Docs](https://docs.representable.org) site for a guide to installing Representable and contributing to various parts of the site. If you find any issues, we would love to know! Please open an issue request for any incomplete documentation.
 
+#### Quick start
+
+```bash
+cp .env.example .env # update the variables
+
+docker compose up -d
+docker compose exec app /bin/bash
+
+# run once to: setup the database, superuser, and test the app
+export DJANGO_SETTINGS_MODULE=representable.settings.dev 
+python manage.py makemigrations
+python manage.py migrate
+python manage.py createsuperuser
+python manage.py loaddata states.json
+python manage.py collectstatic
+python manage.py test
+
+# run server
+python manage.py runserver 0:8000 --settings=representable.settings.dev
+```
+
 ### General Issue Reporting
 For bug reports and general feature requests, please open a [Github issue](https://github.com/Representable/representable/issues/new/choose). We welcome all feedback and suggestions!
 

docker-compose.yml

@@ -0,0 +1,31 @@
+services:
+  app:
+    build: .
+    volumes:
+      - .:/app
+    depends_on:
+      - db
+    # environment:
+    #   - DATABASE_URL=postgresql://representable:password@db/representable_db
+    env_file:
+      - .env
+    ports:
+      - "8000:8000"
+    tty: true
+    stdin_open: true
+  db:
+    image: postgis/postgis:17-3.5-alpine
+    restart: unless-stopped
+    environment:
+      - POSTGRES_DB=representable_db
+      - POSTGRES_USER=representable
+      - POSTGRES_PASSWORD=password
+    volumes:
+      - ./pg_data:/var/lib/postgresql/data
+    ports:
+      - "127.0.0.1:5433:5432" # access via port 5433
+    # creating a new user
+    # psql -U public_test representable_db
+    # CREATE USER public_test WITH encrypted password 'test';
+    # change to select only for non-PII tables
+    # GRANT ALL PRIVILEGES ON DATABASE representable_db to public_test;