Reciprocity is a platform designed to bring people together through the love of food. This full-stack application lets users save and share recipes, create family collections, and schedule food meetups with friends, all while celebrating the bonds and traditions tied to shared meals. (Site - Under Construction)
- Familial Feast: Create and preserve family recipes, tagging them to specific members or branches of your family tree.
- Recipe Sharing: Share recipes with friends and discover new dishes from your community.
- Custom Collections: Organize your favorite recipes into tailored categories for easy access.
- Media-Responsive Design: Seamlessly access your recipes and features on any device, from smartphones to desktops, ensuring a smooth and user-friendly experience.
- React: Dynamic and responsive user interface for a seamless user experience.
- Flask: Efficient and scalable backend framework to handle server-side logic.
- PostgreSQL: Robust relational database for secure and reliable data storage.
- SQLAlchemy: ORM for easy database interactions.
This repository includes detailed documentation to help users and developers navigate the application:
- README: Start here for an overview of the project, including setup instructions and technical details.
- Wireframes: Visual blueprints of the application's design and layout to guide development and provide clarity on the user interface.
- API Documentation: Detailed explanations of available endpoints, their parameters, and responses.
- Postman Collection: Download collection of pre-configured API requests to test and explore the application's backend endpoints easily.
- User Features Documentation: Walkthroughs of the core functionalities, such as creating and sharing recipes, managing collections, and privacy settings.
- User Journeys: Example workflows to showcase how different users interact with the platform.
- React Store Documentation: Insights into how the app manages state for a consistent user experience.
Showcase coming soon! Stay tuned for images of the app in action.
🚀 Getting Started
Check out the live version (site under construction) : https://reciprocity.onrender.com
-
Clone the repository:
git clone https://github.com/yourusername/heart_n_hearth.git cd heart_n_hearth -
Install dependencies:
-
Navigate to the backend and frontend directories and install dependencies for each:
cd react-vite npm installcd app pipenv install -r requirements.txt
-
-
Start the application:
- Backend server:
cd backend flask run - Frontend development server:
cd frontend npm start
- Backend server:
- Advanced Search Filters: Find recipes by dietary preferences, cook time, or ingredients.
- Calendar Food Meetups: Schedule and host cooking events to create unforgettable experiences with loved ones.
- Event Invitations: Send invites to friends and family for food meetups.
- Food Timeline: Visualize the history of your family recipes over generations.
- Order Printed Collection Book: Turn your digital recipe collection into a beautifully printed book, preserving your family’s culinary legacy.
- Ingredient Scaling: Automatically adjust recipe quantities for different group sizes, ensuring you always cook just the right amount.
Get ready to strengthen bonds, share traditions, and create lasting memories through Reciprocity. Bon appétit!