CanTeam is an innovative solution for food sharing in shared kitchens. The name combines "canteen" (English for cafeteria) and "team" to highlight its focus on teamwork and shared responsibility.
Whether it's coffee, tea, sugar, or creamer, CanTeam ensures fair usage and reimbursement among people sharing resources in communal spaces.
-
Track Shared Products
Users can add products to the app by specifying the name, unit (e.g., teabags, teaspoons), and total cost. CanTeam calculates the price per unit for easy tracking. -
Sponsor System
The user who adds a product becomes its sponsor, marking their contribution to the shared resources. -
Usage Logging
Other users can record how much of the product they’ve used. For instance, if someone takes two teabags, they can log it in the app. -
Expense Reconciliation
CanTeam keeps a detailed record of product usage and sponsorship. It calculates how much money each person owes to others, enabling easy monthly reimbursements. -
Local Network Functionality
The app operates over local Wi-Fi, making it perfect for small offices, coworking spaces, or shared apartments. -
Mobile-First Design
Designed with mobile devices in mind, CanTeam ensures a seamless user experience on the go.
Follow these simple steps to set up and start using CanTeam:
- Python: Ensure Python is installed on your system.
- Clone the Repository
Download or clone this repository to your local machine:git clone https://github.com/JanPoniecki/canteam.git cd canteam - Run the Installer Launch the app using the following command:
python install_and_run.py- Access the App
- The terminal will display a QR Code and an address.
- Use your mobile device or any browser on the same Wi-Fi network to scan the QR code or visit the address directly.
- Start Sharing
- Add products, log usage, and track reimbursements effortlessly!
- Adding Products
- Example: You buy a box of 100 teabags for $10.
- Add the product with details:
- Name: Tea
- Unit: Bag
- Total Cost: $10
- CanTeam calculates the price per unit: $0.10 per bag.
- Logging Usage
- Other users can log how many units they’ve consumed. For instance:
- John logs 5 bags.
- Mary logs 3 bags.
- Reimbursement Calculation
- CanTeam keeps track of all contributions and usage. At the end of the month (or any preferred period), users can settle expenses based on the app’s calculations.
- Office Kitchens
Perfect for managing shared supplies like coffee, sugar, and tea. - Shared Apartments
Simplify the distribution of costs for groceries and other communal items. - Coworking Spaces
Promote fairness and accountability in resource sharing. 📱 Accessibility Since CanTeam operates on local Wi-Fi, it doesn’t require an internet connection. Everyone connected to the same Wi-Fi network can use the app seamlessly.
Contributions are welcome! Feel free to fork this repository and submit a pull request with your improvements or ideas.
This project is licensed under the MIT License. See the LICENSE file for more details.
Ready to share fairly? Try CanTeam today! 🍵