Dimagi.com

1. Getting Started Locally
2. Deploying to Heroku
3. PR Guidelines

Getting Started Locally

System Pre-Requisites

1. Install Git

2. Install & Run Redis.

3. Install & Run Postgresql

4. Install pyenv to manage python versions. (Instructions for Ubuntu)

   NOTE: This repository has been tested to run on Python 3.9.x

5. Install python 3.9 with pyenv:

   pyenv install 3.9.11
   

   To set Python 3.9 as the global python, run:

   pyenv global 3.9.11
   

6. Install pyenv-virtualenv (Installation instructions for Ubuntu)

7. Install Yarn

Building the Local Environment

1. git clone this repo to your machine.

2. Setup your python virtual environment

   pyenv virtualenv 3.9.11 dimagi.com
   

3. Activate your python virtual environment NOTE: You will need to do this each time you plan on running this setup locally.

   pyenv activate dimagi.com
   

4. Install pipenv

   pip install pipenv
   

5. Install Pipfile dependencies

   pipenv install
   

   Note: if this fails and you are on Ubuntu, you should also make sure to install the following system dependencies

   sudo apt-get install libpq-dev
   

6. Install Yarn dependencies

   yarn install
   

7. Install postcss

   sudo npm install -g fs-extra  # for ubuntu only
   sudo npm install -g postcss-cli
   sudo npm install -g autoprefixer
   

8. Create a .env file, and make any necessary edits.

   cp dev.env .env
   

9. Initialize the database

   manage.py createdb
   

10. Run the server using

    manage.py runserver
    

Deploying to Heroku

1. Install the Heroku CLI.

2. Login with the Heroku CLI to your invited heroku account that manages the dimagidotcom app. Make sure to add your keys with the CLI. These instructions should have been emailed to you with the Heroku team member invite.

3. Make sure you followed the steps from Getting Started Locally

4. Set up your origins:

git remote add heroku-prod https://git.heroku.com/dimagidotcom.git
git remote add heroku-staging https://git.heroku.com/dimagidotcom-staging.git

1. Deploy to production via command line:

git push heroku-prod master

Or Deploy to production from the web UI under the Deploy tab.

Deploying & building off a specific branch to Staging

1. Deploying master to heroku-staging will automatically trigger a build but if you want to build a specific branch on staging, first push that branch to github, and then manually Deploy that branch from the [Heroku web UI](https://dashboard.heroku.com/apps/dimagidotcom-staging/deploy/github.

PR Guidelines

HTML

Are </div> (and other deeply nested) tags properly commented with a selector for easy identification?

<div class="content">
  ...
</div> {# .content #}

Is all human readable text in a {% blocktrans %}?

{% blocktrans %}
  Human Readable Text!
{% endblocktrans %}