CommonThread is an open-source collaborative tool that enables users to turn stories into insights. Community-based organizations, journalists, researchers, and community members alike can use the tool to efficiently gather stories, aggregate them, and understand common threads to draw insights for action.
See documentation for the project at https://uchicago-capp-30320.github.io/CommonThread/.
CommonThread is built off of two primary components: A Svelte-kit frontend that communicates with a Django-based backend. This means that for setup, there are two main components that need to be done.
To set up a local development environment, follow these steps:
Refer to backend environment setup here
Refer to frontend environment setup here
There will be 2 main relevant .env files- one in commonthread, one in frontend. If the product is being deployed with docker, an additional .env.production file is necessary under frontend in order to enable docker to use the correct hostnames. If you are looking to work with the developers of this project, reach out for the necessary files. If you are looking to fork this project for your own purposes, we can provide lists of the necessary things that will need to be set within environment variables for the project to function.
CommonThread
├── commonthread
│ ├── commonthread
│ │ └── __pycache__
│ └── ct_application
│ ├── __pycache__
│ ├── functions
│ ├── migrations
│ ├── static
│ ├── templates
│ └── tests
│ ├── backend
│ └── frontend
└── frontend
├── src
│ ├── components
│ │ └── story
│ ├── lib
│ │ ├── assets
│ │ │ ├── illustrations
│ │ │ └── logos
│ │ └── components
│ │ └── story
│ └── routes
│ ├── about
│ ├── login
│ ├── org
│ │ └── [org_name]
│ │ ├── [story_id]
│ │ ├── dashboard
│ │ └── org-admin
│ ├── signup
│ └── stories
│ └── new
└── staticCheck our issue tracker.
This project was built under the supervision of James Turk for the Software Engineering for Civic Tech course, part of the MS in Computational Analysis and Public Policy at the University of Chicago. The developer team (presented in alphabetical order) includes:
| Contributor | Roles |
|---|---|
| Austin Steinhart | Front-End Lead and Architect |
| Fatima Irfan | Data Engineering Lead and Back-end Engineer |
| Jacob Trout | Back-end Engineer and ML Specialist |
| Onur Büyükkalkan | Back-end Lead and Data Engineer |
| Paul Soltys | Chief Architect and Data Engineer |
| Praveen Chandar | ML Specialist, Back-end and Front-end Engineer |
| Regina I. Medina | QA Specialist, Back-end and Front-end Engineer |
Branding resources and customized illustrations designed by Pili Medina 🐈.