Welcome to FamBoard, a web-based household dashboard designed to streamline your family's chores, meals, events, and more. This project aims to simplify household management, making it easier for families to stay organized and connected.
FamBoard offers a range of features to help families manage their daily tasks efficiently:
- Chores Management: Assign and track household chores for each family member.
- Meal Planning: Organize meals for the week, including grocery lists.
- Event Scheduling: Keep track of family events and appointments.
- User-Friendly Interface: Easy to navigate, designed for all ages.
- Mobile-Friendly: Access FamBoard on any device, including smartphones and tablets.
- Offline Capabilities: Works even without an internet connection, thanks to PWA support.
- Raspberry Pi Support: Run your dashboard on a Raspberry Pi for a home server experience.
FamBoard is built using the following technologies:
- Flask: A lightweight Python web framework.
- SQLite: A simple, lightweight database for storing data.
- Python: The primary programming language used for backend development.
- HTML/CSS/JavaScript: For frontend development.
- Progressive Web App (PWA): Enhances the user experience by allowing offline access.
- Raspberry Pi: For those who want to host their own instance.
To get started with FamBoard, follow these steps:
-
Clone the Repository:
git clone https://github.com/T-UDOM-2017-02736/famboard.git cd famboard -
Install Dependencies:
Make sure you have Python and pip installed. Then run:
pip install -r requirements.txt
-
Set Up the Database:
Initialize the SQLite database:
python setup_db.py
-
Run the Application:
Start the Flask server:
python app.py
-
Access the Dashboard:
Open your web browser and go to
http://127.0.0.1:5000.
For the latest release, download it here and follow the same installation steps.
Once you have the application running, you can begin using FamBoard:
- Create an Account: Sign up to create your family profile.
- Add Family Members: Invite family members to join the dashboard.
- Manage Chores: Assign chores to family members and track their progress.
- Plan Meals: Use the meal planner to organize weekly meals.
- Schedule Events: Add events to the calendar and set reminders.
The user interface is designed to be intuitive. You can navigate through different sections easily, making household management a breeze.
We welcome contributions to FamBoard! If you want to help improve the project, please follow these steps:
-
Fork the Repository: Click on the "Fork" button on the top right corner.
-
Create a New Branch:
git checkout -b feature/YourFeature
-
Make Your Changes: Implement your feature or fix a bug.
-
Commit Your Changes:
git commit -m "Add Your Feature" -
Push to Your Branch:
git push origin feature/YourFeature
-
Create a Pull Request: Go to the original repository and click on "New Pull Request."
We appreciate your help in making FamBoard better!
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or feedback, please reach out:
- Email: support@famboard.com
- GitHub Issues: Use the Issues tab in this repository for bug reports or feature requests.
Thank you for checking out FamBoard! We hope it helps you and your family stay organized and connected. For the latest updates, be sure to check the Releases section.