README.md

Self-Help-Programs API

❓ Set-up instructions

❓ How to run tests

❓ Endpoint

❓ Example GraphQL queries

Languages & Libraries:

• Python 3.7
• Gunicorn
• Flask
• Postgres
• GraphQL
• Relay
• Graphene
• SQLAlchemy
• Docker
• graphene.test
• unittest

---

Postgres DB Schema

DB Schema Overview:

Many Programs

    One Program-to-Many Sections

        One Section-to-Many Activities

            Two types of Activities:

                - Question Activity (multiple choice question)
                        - One Question-to-Many Answer Options(where only one option can be picked)

                - Text Actvity

---

.
├── README.md
├── docker-compose.yml
├── db_schema.png
├── run_app.sh
├── teardown.sh
├── src
│   ├── Dockerfile
│   ├── config.py
│   ├── manage.py
│   ├── api
│   │   ├── __init__.py
│   │   ├── controllers
│   │   │   ├── __init__.py
│   │   │   └── routes.py
│   │   ├── models
│   │   │    └── db_models
│   │   │         ├── __init__.py
│   │   │         ├── program.py
│   │   │         ├── question_activity.py
│   │   │         ├── question_activity_option.py
│   │   │         ├── section.py
│   │   │         └── text_activity.py
│   │   │
│   │   └── schema.py
│   │   └── settings.py
│   ├── requirements.txt
│   └── tests
│       ├── __init__.py
│       ├── test_graphql.py
│       └── test_views.py
└── db
    ├── Dockerfile
    └── create.sql

---

How to run app:

This app uses flask_script's Manager to initialize the app, seed the db and run the tests from the command line. You can find the Manager instance in src/manage.py.

Set up:

NOTE: I've included the .env file to facilitate setup.

To run app and seed db, in root directory, run:

sh run_app.sh

App can be found here:

http://0.0.0.0:5000/graphql

Tear down:

sh teardown.sh

NOTE: you do not need to teardown the app before running the tests

---

How to run tests:

docker-compose run --rm api python manage.py test

---

Endpoint:

http://0.0.0.0:5000/graphql?query={}

---

GraphQL Queries:

Fetch all programs:

{
  allPrograms {
    edges {
      node {
        id
        name
      }
    }
  }
}

One program, One section:

{
  program(id: "UHJvZ3JhbU9iamVjdDox") {
    id
    name
    description
    sections(first: 1) {
      edges {
        node {
          id
          name
          description
          orderIndex
          overviewImage
          programId
        }
      }
    }
  }
}

Sections with pagination:

{
  allPrograms {
    edges {
      node {
        id
        name
        sections(first: 2) {
          totalCount
          edges {
            node {
              id
              name
              description
            }
            cursor
          }
          pageInfo {
            endCursor
            hasNextPage
          }
        }
      }
    }
  }
}

One program, all sections, all activities:

{
  program(id: "UHJvZ3JhbU9iamVjdDox") {
    id
    name
    description
    sections {
      edges {
        node {
          id
          name
          description
          orderIndex
          overviewImage
          programId
          questionActivities {
            edges {
              node {
                id
                questionActivityContent
                sectionId
                questionOptions {
                  edges {
                    node {
                      questionOptionContent
                      questionActivityId
                    }
                  }
                }
              }
            }
          }
          textActivities {
            edges {
              node {
                id
                textActivityContent
                sectionId
              }
            }
          }
        }
      }
    }
  }
}