Production Release - 4 November 2024

.env.example

@@ -0,0 +1,2 @@
+CHATWOOT_TOKEN=example
+CHATWOOT_IDENTITY_VALIDATION=example

.github/workflows/deploy-dev.yml

@@ -0,0 +1,55 @@
+name: Deploy to Dev
+
+on:
+  push:
+    branches:
+      - dev
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: DEV
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: 'us-east-1'
+
+      - name: Download env.dev from S3
+        run: |
+          aws s3 cp s3://faprivate/envs/env.dev env.dev
+
+      - name: Create Virtual Environment and Install dependencies
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Update Zappa environment variables and deploy
+        run: |
+          source venv/bin/activate
+          python update_zappa_envs.py dev
+          zappa update dev
+
+      - name: Run Migrations
+        run: |
+          source venv/bin/activate
+          zappa manage dev migrate
+
+      - name: Run Collectstatic
+        run: |
+          source venv/bin/activate
+          zappa manage dev "collectstatic --noinput"

.github/workflows/deploy-prod.yml

@@ -0,0 +1,55 @@
+name: Deploy to Prod
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: PROD
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v2
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: 'us-east-1'
+
+      - name: Download env.prod from S3
+        run: |
+          aws s3 cp s3://faprivate/envs/env.prod env.prod
+
+      - name: Create Virtual Environment and Install dependencies
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Update Zappa environment variables and deploy
+        run: |
+          source venv/bin/activate
+          python update_zappa_envs.py prod
+          zappa update prod
+
+      - name: Run Migrations
+        run: |
+          source venv/bin/activate
+          zappa manage prod migrate
+
+      - name: Run Collectstatic
+        run: |
+          source venv/bin/activate
+          zappa manage prod "collectstatic --noinput"

.gitignore

@@ -7,3 +7,4 @@ deprepagos/media
 *DS_Store
 dbs/
 venv/*
+.env

README.md

@@ -11,9 +11,50 @@ source venv/bin/activate
 pip install -r requirements.txt
 pip install -r requirements-dev.txt
 cp deprepagos/local_settings.py.example deprepagos/local_settings.py
-whoami # copy the output
-open deprepagos/local_settings.py # and paste the output as `DB_USER` value
+cp .env.example .env
 createdb deprepagos_development
+```
+
+## Set envs.
+
+You can copy the values from dev environment.
+
+### DB
+
+Use your recently created local DB
+
+```
+DB_DATABASE
+DB_HOST
+DB_PORT
+DB_USER
+```
+
+### MercadoPago
+
+Create a SELLER TEST USER in MercadoPago and set the following
+envs. [Instructions here]('https://www.mercadopago.com.ar/developers/es/docs/your-integrations/test/accounts')
+
+Set the envs `MERCADOPAGO_PUBLIC_KEY`, `MERCADOPAGO_ACCESS_TOKEN` with the onces from the SELLER TEST USER.
+
+Then set up a [webhook]('https://www.mercadopago.com.ar/developers/es/docs/your-integrations/notifications/webhooks')
+pointing to `{your local env url}/webhooks/mercadopago`. And set the env `MERCADOPAGO_WEBHOOK_SECRET` with the secret
+you set in the webhook creation.
+
+I recommend using
+a [cloudflare tunnel]('https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/'),
+or [ngrok]('https://ngrok.com/), or similar to expose your local server to the internet.
+
+### Login with Google
+
+Create a project in Google Cloud Platform and enable the Google+ API. Then create OAuth 2.0 credentials and set the envs
+`GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET` with the values from the credentials.
+
+On the OAuth consent screen, set the authorized redirect URIs to `{your local env url}/accounts/google/login/callback/`
+
+### Once you have the envs set up, you can run the following commands:
+
+```sh
 python manage.py migrate
 whoami # copy the output
 python manage.py createsuperuser # paste the output as username, leave email empty, and set some password
@@ -32,17 +73,11 @@ deactivate # if you want to deactivate the virtualenv
 
 ## Deploy
 
-The project is meant to be deployed in AWS Lambda. `django-zappa` handles the
-upload and configuration for us. You can see the config in
-[`zappa_settings.json`](zappa_settings.json).
-
-To deploy from a local dev environment follow these steps:
+### DEV
 
-1. Setup your personal AWS credentials as the `[default]` profile (needed by
-   Zappa)
-
-2. Deploy with `zappa update dev` (or `zappa update prod`)
+Just push to the `dev` branch and the pipeline will deploy to the dev environment.
 
+### PROD
   > [!IMPORTANT]  
   > In OS X you need to use a Docker image to have the same linux environment
   > as the one that runs in AWS Lambda to install the correct dependencies.
@@ -54,6 +89,11 @@ To deploy from a local dev environment follow these steps:
   > zappashell> zappa update dev
   > ```
 
+Please don't push to the `main` branch directly. Create a PR and merge it on `dev` first. Then create a PR from `dev` to `main`.
+
+`TODO ongoing: The pipeline will deploy to the prod environment.`
+
+If for some horrible reason you need to push to `main` directly, PLEASE, make sure to backport the changes to `dev` afterwards.
 3. Update the static files to S3:
 
         $ python manage.py collectstatic --settings=deprepagos.settings_prod

deprepagos/local_settings.py.example

@@ -1,40 +1,7 @@
 import os
 
-DEBUG = True
 
 EXTRA_INSTALLED_APPS = ['django_extensions']
 
-DATABASES = {
-    'default': {
-        'ENGINE': 'django.db.backends.postgresql',
-        'NAME': os.environ.get('DB_DATABASE', 'deprepagos_development'),
-        'USER': os.environ.get('DB_USER', '<FIND_ME_BY_TYPING_whoami_IN_TERMINAL>'),
-        'PASSWORD': os.environ.get('DB_PASSWORD', ''),
-        'HOST': os.environ.get('DB_HOST', '127.0.0.1'),
-        'PORT': '5432',
-    }
-}
-
 PROJECT_ROOT = os.path.dirname(os.path.abspath(__file__))
 STATIC_ROOT = os.path.join(PROJECT_ROOT, 'collected_static')
-
-PIPELINE = {
-    'PIPELINE_ENABLED': False,
-    'SHOW_ERRORS_INLINE': False,
-    'COMPILERS': (
-        'libsasscompiler.LibSassCompiler',
-    ),
-    'CSS_COMPRESSOR': 'pipeline.compressors.csshtmljsminify.CssHtmlJsMinifyCompressor',
-    'STYLESHEETS': {
-        'main': {
-            'source_filenames': (
-                'scss/fuego.scss',
-                'scss/global.scss',
-            ),
-            'output_filename': 'css/main.css',
-            'extra_context': {
-                'media': 'screen,projection',
-            },
-        },
-    },
-}