## Mission π
Human Essentials is an inventory management system built to address the needs of [Diaper Banks](https://nationaldiaperbanknetwork.org/diaper-need/) as directly and explicitly as possible and adapted to meet the needs of other Essentials Banks. Essentials Banks maintain inventory, receive donations and other human essentials supplies (e.g. diapers, period supplies), and issue distributions to community partner organizations. Like any non-profit, they also need to perform reports on this data and have day-to-day operational information they need. This application aims to serve those needs and facilitate the general operations of the Diaper Banks (e.g., using barcode readers, scale weighing, inventory audits).
## Impact π
Human Essentials has over 200 registered banks across the United States at **no cost** to them. It is currently helping over **3 million** children receive diapers and over **400k** period supply recipients receive period supplies. Our team is in partnership with the [National Diaper Bank Network (NDBN)](https://nationaldiaperbanknetwork.org/) and can be found in their annual conference that brings numerous of non-profit organizations that distribute essential products to people.
We are proud of our achievements up to date but there is much more to do! This is where you come in...
## Ruby for Good
Human Essentials is one of many projects initiated and run by Ruby for Good. You can find out more about Ruby for Good at https://rubyforgood.org
## Digital Public Good π
The [Digital Public Goods Alliance](https://digitalpublicgoods.net/registry/) recognizes Human Essentials as a digital public good (DPG). This project supports the following Sustainable Development Goals:
* [SDG 1](https://sdgs.un.org/goals/goal1) - End poverty in all its forms everywhere
* [SDG 3](https://sdgs.un.org/goals/goal3) - Ensure healthy lives and promote well-being for all at all ages
* [SDG 10](https://sdgs.un.org/goals/goal10) - Reduce inequality within and among countries
Use as an Organization or Contribute as an Individual/Team to this Project:
- [NGO Adoption Info](ngo.md) - information about how to use this DPG
- [Skills Based Volunteering Info](sbv.md) - information about how to volunteer
## Welcome Contributors! π
Thanks for checking us out! Check out our [Contributing Guidelines](https://github.com/rubyforgood/human-essentials/blob/main/CONTRIBUTING.md) on how to contribute.
## Deployment Process
The human-essentials & partner application should ideally be deployed on a weekly or bi-weekly schedule depending on the merged updates in the main branch. This is the process we take to deploy updates from our main branch to our servers.
### Requirements
- SSH access to our servers (usually granted to core maintainers)
- Login credentials to our [Mailchimp](https://mailchimp.com/) account
### Steps
#### 1. Merge main into production branch
All deploys deploy from the production branch, which keeps track of what is currently in production.
```sh
git checkout production
git merge main
```
#### 2. Tag & Release
1. Push a tag with the appropriate date versioning. Refer to the [releases](https://github.com/rubyforgood/human-essentials/releases) for the correct versioning. For example, if you are deploying on June 23, 2024:
```sh
git tag 2024.06.23
git push origin tag 2024.06.23
```
2. Publish a release, associated to that tag pushed up in the previous step, [here](https://github.com/rubyforgood/human-essentials/releases/new). Include details about the release's updates (we use this to notify our stakeholders on updates via email).
### Running delayed jobs
Run delayed jobs locally with the `rake jobs:work` command. This is necessary to view any emails in your browser. Alternatively, you can run a specific delayed job by opening a Rails console and doing something like:
```ruby
Delayed::Job.last.invoke_job
```
You can replace the `last` query with any other query (e.g. `Delayed::Job.find(123)`).
# Acknowledgements
Thanks to Rachel (from PDX Diaperbank) for all of her insight, support, and assistance with this application, and Sarah ( http://www.sarahkasiske.com/ ) for her wonderful design and CSS work at Ruby For Good '17!
# License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Frubyforgood%2Fdiaper?ref=badge_large)
# β¨ Contributors β¨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
