Skip to content

Commit

Permalink
Merge pull request #3 from grahfmusic/1.0
Browse files Browse the repository at this point in the history
added new save/load feature and fixed code for 1.0
  • Loading branch information
grahfmusic authored Oct 30, 2024
2 parents d81e580 + 5039ded commit ab06ee0
Show file tree
Hide file tree
Showing 5 changed files with 1,010 additions and 948 deletions.
66 changes: 63 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Here is an updated version of your README file for release version 1.0. I've included additional details regarding how the tool works, its features and functions, technologies used, data storage methods, and specific Nginx and Apache configurations.

---

# Christmas Invitation Management Tool
## Version 0.1
## Version 1.0

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.

Expand All @@ -20,6 +24,9 @@ Welcome to the **Christmas Invitation Management Tool**! This web application is
- [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)
Expand All @@ -41,15 +48,15 @@ These instructions will help you set up and run the project on your local machin
### Prerequisites

- **Web Server**: Apache, Nginx, or any web server capable of running PHP scripts.
- **PHP**: Version 5.3.0 or higher with OpenSSL extension enabled.
- **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
https://github.com/grahfmusic/online-christmas-list.git
git clone https://github.com/grahfmusic/online-christmas-list.git
```

2. **Navigate to the project directory:**
Expand Down Expand Up @@ -123,6 +130,59 @@ These instructions will help you set up and run the project on your local machin
- **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
<VirtualHost *:80>
ServerName yourdomain.com
DocumentRoot /path/to/christmas-invitation-tool
<Directory /path/to/christmas-invitation-tool>
Options Indexes FollowSymLinks
AllowOverride All
Require all granted
</Directory>
<Files "guest_list.dat">
Require all denied
</Files>
ErrorLog ${APACHE_LOG_DIR}/error.log
CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>
```

## Security

- **Data Encryption**: Guest data is encrypted on the server using AES-256-CBC encryption.
Expand Down
Loading

0 comments on commit ab06ee0

Please sign in to comment.