47 lines
1.7 KiB
Markdown
47 lines
1.7 KiB
Markdown
# Family Hub
|
|
|
|
A centralized family organization system with tabs for chores, grocery lists, and meal planning.
|
|
|
|
## Features
|
|
- Tabbed interface for different family needs
|
|
- JSON-based data storage
|
|
- Daily automated exports
|
|
- Mobile-friendly interface
|
|
|
|
## Setup
|
|
1. Clone this repository to your web server
|
|
2. Ensure proper permissions on data directory
|
|
3. Set up the daily cron job for exports
|
|
4. Access the hub at http://your-local-ip/familyHub/
|
|
|
|
## Directory Structure
|
|
familyHub/
|
|
├── assets/ # Static assets
|
|
│ ├── css/ # CSS files
|
|
│ │ └── style.css
|
|
│ ├── js/ # JavaScript files
|
|
│ │ └── main.js
|
|
│ └── img/ # Images
|
|
├── config/ # Configuration files
|
|
│ └── config.php
|
|
├── data/ # JSON data storage (not tracked in git)
|
|
│ ├── chores.json
|
|
│ ├── groceries.json
|
|
│ └── meals.json
|
|
├── includes/ # PHP includes/components
|
|
│ ├── header.php
|
|
│ ├── footer.php
|
|
│ ├── db.php # JSON file handling functions
|
|
│ └── utils.php # Utility functions
|
|
├── exports/ # Temporary location for exports (not tracked in git)
|
|
├── scripts/ # Scripts for cron jobs
|
|
│ └── daily_export.php
|
|
├── tabs/ # Tab-specific functionality
|
|
│ ├── chores.php
|
|
│ ├── groceries.php
|
|
│ └── meals.php
|
|
├── .gitignore
|
|
├── .cursor.json # Cursor editor configuration
|
|
├── README.md
|
|
├── index.php # Main entry point
|
|
└── export.php # Export functionality |