Welcome to the BetterAngels Monorepo! This repository contains the codebases for both the frontend and backend components of the BetterAngels project. Our goal is to address homelessness through innovative technology solutions.
- Project Overview
- Frontend Development
- Backend Development
- Seed Data
- Development Workflow
- Shelter DB
- Licensing Details
- Contributing
BetterAngels is a nonprofit organization focused on addressing the homelessness epidemic in Los Angeles. This monorepo contains the core applications that power our platform, including mobile apps, web apps, and backend services.
The frontend is built with React Native and uses Expo for development across multiple platforms.
- Frontend Development Guide: This guide covers setting up the development environment, running the application, and testing.
The backend is built with Django, a high-level Python web framework, and uses Celery for distributed task processing.
- Backend Development Guide: This guide covers setting up the development environment, running the backend server, and integrating Celery for task processing.
The following users should exist as part of seed data:
- Agent - can access front-end account as an agent
- username: agent
- email:
[email protected] - password: password
- Client - can access front-end account as a client
- username: client
- email:
[email protected] - password: password
- Django Admin - can access backend admin panel
- username: admin
- email:
[email protected] - password: password
To maintain a consistent and efficient development process, we have established a workflow that includes branch management, pull requests, and code reviews.
- Development Workflow Guide: This document outlines our development practices, including how to create branches, submit pull requests, and conduct code reviews.
Shelter DB is a web project for discovering homeless shelters in LA County. More documentation for Shelter DB Project can be found here.
All of the source code to this product is released as free and open source, licensed under the GNU Affero General Public License (AGPL). This license ensures that our code remains free and open, encouraging others to contribute and share improvements while also ensuring that any modifications are made available to the community.
For assets in this repository, you must also keep any license notices present in the source code and retain any attributions.
For additional information regarding licensing and attribution requirements and contribution guidelines, please refer to the README in the respective directory. See our Attribution Guidlines for more information.
We are grateful to the open-source community for their invaluable contributions. By integrating these assets and leveraging other open-source resources (such as source code, libraries, frameworks, etc.), we not only enhance our application but also contribute to a broader ecosystem of shared resources and innovation. Thank you for supporting open source!
If you have any questions about licensing details or can provide information regarding any missing or incorrect licenses, please contact Better Angels United, Inc. at [email protected].
Are you a passionate technologist with a heart for service? Better Angels Tech Corps is calling on volunteers like you to help us craft a software platform that addresses every facet of homelessness. From outreach and shelter to client services and housing, we’re committed to creating holistic tech solutions that streamline processes and enhance user experiences for those most in need in our community.
We have immediate opportunities for volunteers in front-end and back-end development, infrastructure, and testing. Join us in the early stages of our volunteer program and make a difference.
Check out our volunteer portal to sign up as a volunteer and get started!
Feel free to explore the individual guides linked above for more detailed instructions on setting up and contributing to the BetterAngels project. If you have any questions, please refer to the respective README files or reach out to our team.