Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grahfmusic/online-christmas-list
The Christmas Invitation Management Tool is a web-based application that allows to efficiently manage a guest list for party/event which is written in HTML5 and PHP.
https://github.com/grahfmusic/online-christmas-list
business-service crm html5 javascript json list management-system organizer php web webapp webapplication webservice website
Last synced: 4 days ago
JSON representation
The Christmas Invitation Management Tool is a web-based application that allows to efficiently manage a guest list for party/event which is written in HTML5 and PHP.
- Host: GitHub
- URL: https://github.com/grahfmusic/online-christmas-list
- Owner: grahfmusic
- License: mit
- Created: 2024-10-30T00:59:42.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-07T13:16:04.000Z (7 days ago)
- Last Synced: 2025-01-07T14:26:44.558Z (7 days ago)
- Topics: business-service, crm, html5, javascript, json, list, management-system, organizer, php, web, webapp, webapplication, webservice, website
- Language: HTML
- Homepage:
- Size: 321 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Christmas Invitation Management Tool
## Version 1.01 :: Created by Grahf 2024 (Dean Thomson)
Welcome to the **Christmas Invitation Management Tool**! This web application is designed to help manage the guest list for our upcoming holiday celebration. It provides an intuitive interface to add, edit, and organize guest information efficiently.
### Why This Tool Was Created
The company I work for needed a quick, centralised tool that could be used repeatedly on our internal servers to easily generate PDFs, spreadsheets, or CSV files for the yearly Christmas party attendee list. Some employees, not being technical, struggled with version control, leading to a confusing mess of attendee lists. It became increasingly difficult to determine which version was accurate. To resolve this issue for all future events, this tool was created in just an hour, ensuring a straightforward and efficient solution.
## Table of Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Viewing Guest Lists](#viewing-guest-lists)
- [Adding a New Guest](#adding-a-new-guest)
- [Editing Guest Details](#editing-guest-details)
- [Sorting the Lists](#sorting-the-lists)
- [Deleting a Guest](#deleting-a-guest)
- [Saving Changes](#saving-changes)
- [Undoing Actions](#undoing-actions)
- [Exporting the Guest List](#exporting-the-guest-list)
- [Web Server Configuration](#web-server-configuration)
- [Nginx Configuration](#nginx-configuration)
- [Apache Configuration](#apache-configuration)
- [Security](#security)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgments](#acknowledgments)
## Features
- **Guest Management**: Add, edit, and remove guests from the attending or not attending lists.
- **Sorting**: Sort guests by name or company.
- **Data Persistence**: Guest data is securely saved and loaded from the server.
- **Export Options**: Export the guest list as a PDF or Excel spreadsheet.
- **Undo Functionality**: Undo the most recent action.
- **Responsive Design**: Optimized for both desktop and mobile devices.
## Getting Started
These instructions will help you set up and run the project on your local machine for development and testing purposes.
### Prerequisites
- **Web Server**: Apache, Nginx, or any web server capable of running PHP scripts.
- **PHP**: Version 7.0 or higher with OpenSSL extension enabled.
- **Browser**: A modern web browser (Google Chrome, Mozilla Firefox, Microsoft Edge).
### Installation
1. **Clone the repository:**
```bash
git clone https://github.com/grahfmusic/online-christmas-list.git
```
2. **Navigate to the project directory:**
```bash
cd christmas-invitation-tool
```
3. **Set up the web server:**
- Place the project files (`index.html`, `save_guest_list.php`, `load_guest_list.php`) in the web server's root directory or a virtual host directory.
4. **Set file permissions:**
- Ensure the server has write permissions to create and modify the `guest_list.dat` file.
```bash
chmod 660 guest_list.dat
```
5. **Configure the encryption key:**
- Open `save_guest_list.php` and `load_guest_list.php`.
- Replace `'your-secret-key'` with a strong, secure key.
- **Important**: Keep this key confidential and do not expose it publicly.
## Usage
### Viewing Guest Lists
- The main interface displays two lists:
- **Attending**: Guests who have confirmed their attendance.
- **Not Attending**: Guests who are not attending.
### Adding a New Guest
- **To the Attending List:**
1. Click **"Add Attendee"**.
2. Enter the guest's name.
3. The guest will appear in the **Attending** list.
- **To the Not Attending List:**
1. Click **"Add Not Attending"**.
2. Enter the guest's name.
3. The guest will appear in the **Not Attending** list.
### Editing Guest Details
1. Click the checkbox next to the guest's name to enter edit mode.
2. Edit the **Name**, **Company**, and **Comments** fields.
3. Uncheck the checkbox to save changes.
### Sorting the Lists
- Click **"Sort by Name"** or **"Sort by Company"** to sort the list accordingly.
### Deleting a Guest
- Click the **"Delete"** button next to the guest's entry.
### Saving Changes
- Click **"Save List"** to save all changes to the server.
### Undoing Actions
- Click **"Undo"** to reverse the most recent action.
### Exporting the Guest List
- **As PDF**: Click **"Save as PDF"** to download a PDF version.
- **As Spreadsheet**: Click **"Save as Spreadsheet"** to download an Excel file.
## Web Server Configuration
### Nginx Configuration
To set up Nginx to properly handle PHP requests and serve this tool, add the following configuration block to your Nginx server block:
```nginx
server {
listen 80;
server_name yourdomain.com;
root /path/to/christmas-invitation-tool;
index index.html index.php;
location / {
try_files $uri $uri/ =404;
}
location ~ \\.php$ {
include snippets/fastcgi-php.conf;
fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
}
location ~ /guest_list\\.dat$ {
deny all;
}
}
```
### Apache Configuration
To set up Apache to properly handle PHP requests and serve this tool, add the following configuration to your virtual host:
```apache
ServerName yourdomain.com
DocumentRoot /path/to/christmas-invitation-tool
Options Indexes FollowSymLinks
AllowOverride All
Require all granted
Require all denied
ErrorLog ${APACHE_LOG_DIR}/error.log
CustomLog ${APACHE_LOG_DIR}/access.log combined
```
## Security
- **Data Encryption**: Guest data is encrypted on the server using AES-256-CBC encryption.
- **Secure Key Management**: The encryption key should be stored securely and not exposed publicly.
- **HTTPS Recommended**: Use HTTPS to encrypt data transmission between the client and server.
## Contributing
We welcome contributions! Please follow these steps:
1. Fork the repository.
2. Create a new branch:
```bash
git checkout -b feature/your-feature-name
```
3. Commit your changes:
```bash
git commit -m "Add your message"
```
4. Push to the branch:
```bash
git push origin feature/your-feature-name
```
5. Open a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- **Front-End Libraries**:
- [jsPDF](https://github.com/parallax/jsPDF)
- [jsPDF-AutoTable](https://github.com/simonbengtsson/jsPDF-AutoTable)
- [SheetJS (XLSX)](https://github.com/SheetJS/sheetjs)
- **Fonts**:
- [Overpass](https://fonts.google.com/specimen/Overpass)
- [Ubuntu Mono](https://fonts.google.com/specimen/Ubuntu+Mono)