New Arrivals Chi

New Arrivals Chi is a resource guide developed by six graduate students from the University of Chicago to help newly arrived individuals navigate the City of Chicago and its available resources. New Migrants often find themselves struggling with the complexities of accessing essential resources, from navigating systems to staying updated on what's available. Our goal is to provide accurate, up-to-date, and actionable information to address common challenges faced by newcomers.

The public facing site includes a guide for getting started in Chicago, legal support and health information. It also includes a two tiered login structure that allows organization to login and update their information, and site administrators to login and manage all organizations.

This project is student run in collaboration with various Community Based Organizations. It is a work in progress, and we look forward to expanding it to include additional services in the near future!

Table of Contents

1. Running the Application
   1. Project Structure
   2. Installing
   3. Running the Project
   4. Running the Tests
   5. Running the Data Migration
   6. Updating and Compiling Translations
2. Using the Application
3. Design and Values
4. Next Steps
5. Authors
6. License
7. Acknowledgments
8. Get in Touch

Running the Application

Follow these instructions to get the project running on your computer for development and testing.

Project Structure

• .github/: This folder contains the templates and workflows for our github repository.
• docs/: This folder contains documents outlining decisions made throughout the development process.
  • decisions/: This folder contains the decisions made regarding the various application components.
  • design/: This folder contains documentation for the design process.
  • endpoints/: This folder contains the enpoints for the pages of the application.
  • models/: This folder contains the data models for the database.
  • style_templates/: This folder contains the sylistic decisions to follow when contributing to the application.
• new_arrivals_chi/: This folder contains the New Arrivals Chi application.
  • app/: This folder contains the frontend, backend, and database code for the application.
  • migrations/: This folder contains the migrations to establish the database.
• tests/: This folder contains the test scripts for the application.

Installing

Poetry:

1. Install Poetry:

   curl -sSL https://install.python-poetry.org | python3 -

2. Navigate to your the project directory and use Poetry to install project dependencies:

   poetry install

Running the Project

1. Navigate to your the project directory and use Poetry to update project dependencies:

   poetry update

2. Activate the Poetry virutal environment:

   poetry shell

3. Run application:

   python new_arrivals_chi/app/main.py

Running the Tests

• Run all tests:

  poetry run pytest

• Run a specific test:

  poetry run pytest tests/app_home_test.py::test_home_page_status

• Run database tests:

  poetry run pytest tests/db_test.py

Creating a database migration

1. Activate the Poetry virutal environment:

   poetry shell

2. Before making any changes, stamp the database with the current revision:

   make stamp_db

3. Make your changes to the database models in new_arrivals_chi/app/models.py.

4. Generate a migration, you should see a new file in new_arrivals_chi/migrations/versions/:

   make create_revision

   Note that you may need to make changes to the migration file to ensure that the migration is correct.

5. Apply the migration to the database:

   make update_db

   The changes should now be reflected in the database.

Updating and Compiling Translations

Translations are handled using Flask-Babel and collaboratively updated using Poedit.

1. Extract Messages: First, extract messages from codebase and HTML files into a .pot file. This file will contain all the translatable strings.

pybabel extract -F new_arrivals_chi/babel.cfg -k _l -o messages.pot .

2. Update Translations: Next, update .po files with the new messages from the messages.pot file. This step ensures that .po files are in sync with the latest translatable strings.

pybabel update -i messages.pot -d new_arrivals_chi/app/translations

3. Edit Translations in Poedit:

Open Poedit and edit the .po files:

• Open Poedit.
• Open the .po file you want to edit (e.g., app/translations//LC_MESSAGES/messages.po).
• Add or update the translations for the new strings.
• Save the .po file.

4. Compile Translations: After editing and saving your translations in Poedit, you need to compile the .po files into .mo files, which are used by Flask at runtime.

pybabel compile -d new_arrivals_chi/app/translations

Using the Application

Below are video demonstrations for using the application from the perspective of 3 different users:

• General User (Unauthenticated)

• Organization Admin (Permission to edit one assigned organization)

• Admin (Permission to edit all organizations)

Design and Values

This project is iterative, and centers user is at the center of our design and implementation.

Read more about our design process and project values

Next Steps

This project is a work in progress, and we are excited to expand features and improve functionality in the near future.

Read our long term viability plan here!

Authors

• Federico Dominguez Molina
• Aaron Haefner
• Summer Long
• Kathryn Link-Oberstar
• Madeleine Roberts
• Xiomara Salazar Flores

License

This project is licensed under the AGPLv3 license.

Acknowledgments

• Thank you to our academic course advisors for this project James Turk and Michael Plunkett for support and guidance throughout this project.

• Thank you to all the incredibly hardworking and amazing community organizations and individuals who generously dedicated their time to educate our team on the current status, needs, and challenges of new arrivals in Chicago, as well as provided valuable recommendations throughout the development of this project.

• Special thanks to:

  • City of Chicago - Office of Immigrants, Migrant, Refugee Rights: Marissa Arrez and Jesús Del Toro
  • Illinois Community for Displaced Immigrants: Johannes Favi
  • The Resurrection Project: Oswaldo Gomez, Laura Mendoza
  • Chicago Street Medicine: Saara-Anne Azizi, Dan Dolan

Get in Touch

This project is a collaborative effort and we would love your feedback!

Have an idea to make it better? Submit feedback or report a bug here.

Want to get in touch? Email us at [email protected].