diff --git a/.gitignore b/.gitignore index 1bac426ac..a451770ee 100644 --- a/.gitignore +++ b/.gitignore @@ -20,4 +20,7 @@ yarn-debug.log* yarn-error.log* # Visual Studio -.vs \ No newline at end of file +.vs + +# IntelliJ IDEA +.idea/ diff --git a/docs/projects/md/about.md b/docs/projects/md/about.md index a99f6fd46..479441205 100644 --- a/docs/projects/md/about.md +++ b/docs/projects/md/about.md @@ -6,14 +6,16 @@ custom_edit_url: null ## Overview -MaterialDerailleur shifts donations into drive for BWorks. It streamlines the process of managing material donations, providing a transparent view into the journey of each donated item. This initiative allows donors to track their contributions from the moment they are donated to their ultimate use, offering them a detailed view of how their items are making a difference. By keeping donors informed about the status and use of their donations, the project fosters a sense of trust and community, encouraging continued support and involvement. The system simplifies the administrative tasks involved in updating and managing donations, making it easier to attract and retain donors who are motivated by seeing the tangible impact of their contributions. +MaterialDerailleur shifts donations into drive for BWorks. A donated item may need to be received, inspected, categorized, repaired, stored, labeled, assigned to a program, and eventually distributed. When that work is tracked in paper logs, spreadsheets, informal messages, or memory, records can be lost or duplicated as an item's condition, location, and status change. + +MaterialDerailleur brings donation records, donor details, item status history, barcode labels, and program information into one system. It gives staff and volunteers a shared view of each item from intake through distribution, while preserving the information BWorks needs to acknowledge donors and report on their contributions. The goal is to help the organization spend less time searching through disconnected records and more time serving its community. ### Information - **Source Code:** [https://github.com/oss-slu/material-derailleur](https://github.com/oss-slu/material-derailleur) [git](https://github.com/oss-slu/material-derailleur) - **Client:** BWorks Organization - **Track:** Client-driven Product -- **Current Tech Lead:** Mathew Shereni [github](https://github.com/MATHEW-SHERENI) +- **Current Tech Lead:** [Mathew Shereni](https://mathewshereni.com/) [github](https://github.com/MATHEW-SHERENI) [linkedin](https://www.linkedin.com/in/mathew-shereni-213130aa/) - **Developers:** - Cole Patrick (capstone) [github](https://github.com/colepatrick) - Tori Willis (capstone) [github](https://github.com/twillis8) @@ -21,13 +23,13 @@ MaterialDerailleur shifts donations into drive for BWorks. It streamlines the pr - Gayatri Jawharkar (alumni) [github](https://github.com/Gayatrinj) - Sarvesh Sonawane (alumni) [github](https://github.com/Sarvesh-7777) - Lalith Adithya Reddy Avuthu (alumni, previous tech lead) [github](https://github.com/alar12) - - Sam Kann (capstone)[github](https://github.com/dracpak) + - Sam Kann (capstone) [github](https://github.com/dracpak) - Josheph Hansen (capstone) [github](https://github.com/truffer11) - Sai Teja Dugyala (capstone) [github](https://github.com/saidugyala) - AJ Ashgari (capstone) [github](https://github.com/aasghari01) - Sai Kiran Reddy Beeram (alumni) [github](https://github.com/saikiran0405) [linkedin](https://www.linkedin.com/in/sai-kiran-reddy-beeram-866075190/) - Mahaboob Pasha Mohammad (alumni) [github](https://github.com/miabu-pashh) [linkedin](https://www.linkedin.com/in/mohammad-mahaboob-pasha/) - - Anjali Putta (Previous tech lead) [github](https://github.com/Anjali0407-git/) [linkedin](https://www.linkedin.com/in/anjali-putta-278164227/) [portfolio](https://anjali-official.netlify.app/) + - Anjali Putta (previous tech lead) [github](https://github.com/Anjali0407-git/) [linkedin](https://www.linkedin.com/in/anjali-putta-278164227/) [portfolio](https://anjali-official.netlify.app/) - Siri Chandana Garimella (proof of concept) [github](https://github.com/SiriChandanaGarimella) - Manohar Reddy YRL (proof of concept) [github](https://github.com/yrlmanoharreddy) - Chirag Gupta (proof of concept) [github](https://github.com/Chirag2x) @@ -36,34 +38,70 @@ MaterialDerailleur shifts donations into drive for BWorks. It streamlines the pr - Brijitha Tialu (proof of concept) [github](https://github.com/Brijitha1609) - Deepak PVSN (proof of concept) [github](https://github.com/deepak-pvsn) - Maryam Moshrefizadeh (proof of concept) [github](https://github.com/Moshrefi) - - -- **Start Date:** Mar, 2024 -- **Adoption Date:** Mar, 2024 +- **Start Date:** March 2024 +- **Adoption Date:** March 2024 - **Technologies Used:** - - React - - Node JS + - React and TypeScript + - Node.js, Express, and TypeScript + - Prisma - PostgreSQL + - Azure Blob Storage - **Type:** Web application - **License:** [MIT](https://opensource.org/license/mit) +## Donation and Inventory Workflow + +MaterialDerailleur supports the full lifecycle of a donated item: + +1. A donation is entered into the system and connected to its donor. +2. Each item is assigned a type, program, condition, and status. +3. A barcode label is generated for inventory tracking. +4. Staff or volunteers add status updates as the item is inspected, repaired, stored, or distributed. +5. The item's history remains connected to the donor for communication and reporting. + +The donated-items dashboard provides a searchable inventory view. Users can search by item ID, name, or donor; filter by item type, program, or status; and access barcode tools for labeling and tracking. + +![MaterialDerailleur donated-items dashboard with search, filters, and barcode actions](./donatedItem.png) + +### Core Platform Capabilities + +- Donation intake and donated-item tracking +- Donor profile and contact management +- Item status history +- Barcode and label generation +- Inventory search and filtering +- Program-based organization of donations +- Administrative workflows for reviewing and updating donated items + ### User Guide -After logging in, users are redirected to the homepage where they are presented with the information about the application. From here, they can navigate to different sections: +After logging in, users are directed to the homepage and can navigate to these sections: + +- **Donations:** View, search, and filter donated items. +- **Donor Form:** Register a new donor. +- **Programs:** Create and manage programs that use donated items, and connect donations to those programs. +- **Item Details:** Review an item's history, update its status, upload photos, print its barcode, and send updates to its donor. + +![MaterialDerailleur donated-item details page with status history, barcode, donor, and program information](./donatedItemDetails.png) + +## Software Architecture + +MaterialDerailleur separates the browser-based client, REST API, structured data, and uploaded files so each part can support a distinct part of the donation workflow. + +![MaterialDerailleur software architecture overview](./architecture-overview.png) -- **Donations:** View a list of all donated items. Search and filter options are available to find specific donations easily -- **Donor Form:** Registers new donor -- **Programs:** Create and manage programs that will utilize the donated items. Each program can be linked to specific donations -- **Item Details:** By selecting an item, users go to a detailed page where they can update the item’s status, upload photos, and send updates to donors via email +- **Client application:** React and TypeScript support reusable forms, search and filtering controls, detail views, and barcode actions while keeping donation and status fields explicit in the interface. +- **REST API:** Node.js, Express, and TypeScript provide a central layer for authentication, role-based access, and donation, donor, inventory, and status workflows. Prisma maps those API operations to the database. +- **Data and file storage:** PostgreSQL stores related records such as donations, donors, item types, programs, statuses, and users. Azure Blob Storage keeps uploaded images and documents outside the relational database. -### Development Priorities +## Development Priorities -- Implement CRUD functionalities in the UI for managing donors, donated items, and programs -- Develop backend APIs to support these CRUD operations -- Enhance the automatic email workflow to ensure real-time updates to donors -- Enable importing of donor and item details from external sources into the database -- Develop detailed documentation to facilitate admin usage of the application +- Implement CRUD interfaces for donors, donated items, and programs. +- Develop backend APIs to support these operations. +- Improve the automatic email workflow so donors receive timely updates. +- Support importing donor and item details from external sources. +- Develop detailed documentation for application administrators. ## Get Involved -If you would like to contribute to this project, please visit our [GitHub page](https://github.com/oss-slu/material-derailleur) to create your own issues or pull requests. +To contribute, visit the [MaterialDerailleur repository](https://github.com/oss-slu/material-derailleur) and open an issue or pull request. diff --git a/docs/projects/md/architecture-overview.png b/docs/projects/md/architecture-overview.png new file mode 100644 index 000000000..05938a348 Binary files /dev/null and b/docs/projects/md/architecture-overview.png differ diff --git a/docs/projects/md/donatedItem.png b/docs/projects/md/donatedItem.png new file mode 100644 index 000000000..b89e1d9a7 Binary files /dev/null and b/docs/projects/md/donatedItem.png differ diff --git a/docs/projects/md/donatedItemDetails.png b/docs/projects/md/donatedItemDetails.png new file mode 100644 index 000000000..eb066e26b Binary files /dev/null and b/docs/projects/md/donatedItemDetails.png differ