CR Connect Development

This document describes the CR Connect Development process. It is written as accompanying material for a class, but is intended to work as a tutorial.

There is a section on installation, but the main purpose is to introduce the CR Connect codebase and our approach to development.

• Introduction
  • Big Picture
  • Repositories
    • CR Connect BPMN
    • CR Connect Frontend
    • CR Connect Workflow
    • SpiffWorkflow
    • Protocol Builder Mock
    • Sartography Libraries
    • Databases
• Environment
  • Working Directory
    • Working Directory
    • Clone from github
  • Requirements
    • Python3
      • Install pipenv
    • Angular
      • node.js
      • Angular
    • Docker
      • Download Docker
      • docker-compose
  • CR Connect Workflow
    • CR Connect Workflow
  • Environment Variables
    • Viewing environment variables
    • Exporting environment variables
    • .env files
  • Postgres
    • Postgres Directory
    • Docker Compose
    • Initialize
  • PB Mock
  • CR Connect BPMN
  • CR Connect Frontend
  • Running Services
    • Run Backend
    • URLs
• CR Connect Workflow
  • Creating a Script
    • Example Script
      • Goal
      • Setup
      • Example
      • Explanation
      • Next
    • Example Workflow
    • Running Workflow
  • Building a Service
    • Tutorial Service
    • Modify Script
  • Adding an API Endpoint
    • Define API Endpoint
      • Definition
      • Schema
      • Python Code
    • Get Cards
      • get_cards
    • Endpoints
  • Exceptions and Error Handling
    • ApiError
      • Definition
      • Usage
    • Helper Methods
      • from_task
      • from_task_spec
    • Example Usage
      • Using from_task
      • Call ApiError directly
    • ApiErrorSchema
    • Unhandled Exceptions
    • More
  • Writing Tests
    • Layout
    • Examples
      • Hello World
      • Test a Script
      • Email Script
      • Calling the API
      • Mocking Data
  • Data Models
    • SQL Alchemy
      • Setup
      • Example
      • Usage
    • Serialization
    • Migrations
      • Layout
      • Revisions
      • Migrations