Changes between Initial Version and Version 1 of BuildInstructions

Timestamp:

01/11/26 01:02:11 (10 days ago)

Author:

193284

Comment:

--

BuildInstructions

@@ +1 @@
+= Documentation / Build Instructions =
+
+This page explains how to run the Wedding Planner Phase P4 prototype locally.
+
+== Prerequisites ==
+ * Python 3.x installed
+ * pip (Python package manager)
+ * (Optional) virtual environment (recommended)
+
+== Project structure ==
+The prototype is implemented as a Flask application.
+
+Main files/folders:
+ * app.py - Flask entry point
+ * requirements.txt - Python dependencies (if available)
+ * data_load.sql - demo dataset loading script
+ * /templates and /static (if UI templates exist)
+
+== 1. Clone / download the project ==
+Obtain the project source code from the repository (or download it as ZIP).
+
+== 2. Create virtual environment (recommended) ==
+Open terminal in the project folder and execute:
+
+{{{
+python -m venv venv
+}}}
+
+Activate:
+
+ * Windows PowerShell:
+{{{
+.\venv\Scripts\activate
+}}}
+
+ * Linux / MacOS:
+{{{
+source venv/bin/activate
+}}}
+
+== 3. Install dependencies ==
+Install required packages:
+
+{{{
+pip install -r requirements.txt
+}}}
+
+If requirements.txt is missing, install manually:
+
+{{{
+pip install flask flask_sqlalchemy psycopg2-binary
+}}}
+
+== 4. Configure database ==
+The prototype uses PostgreSQL database.
+
+Update the database connection string in the configuration (if required), e.g.:
+
+{{{
+postgresql://<username>:<password>@<host>:<port>/<database>
+}}}
+
+== 5. Load demo dataset ==
+To make the prototype runnable immediately, demo data is loaded into the database using SQL scripts.
+
+ * Demo schema created: [[Image(tables_schema_creation.png, width=800)]]
+ * Demo user dataset loaded: [[Image(user_data_load.png, width=800)]]
+ * Demo wedding dataset loaded: [[Image(wedding_data_load.png, width=800)]]
+ * Demo guest dataset loaded: [[Image(guest_data_load.png, width=800)]]
+
+== 6. Run the Flask prototype ==
+Navigate into the folder that contains app.py and run:
+
+{{{
+python app.py
+}}}
+
+If the command fails, ensure the current directory is correct (contains app.py).
+
+Successful run output looks like:
+
+[[Image(http.png, width=800)]]
+
+== 7. Access the prototype ==
+Open the browser:
+
+ * http://127.0.0.1:5000
+
+Prototype overview page:
+
+[[Image(p4-prototype.png, width=800)]]
+
+== 8. Available REST endpoints ==
+The prototype provides the following endpoints:
+
+ * /weddings
+ * /weddings/1/events
+ * /weddings/1/guests
+ * /weddings/1/attendance
+ * /weddings/1/rsvp
+ * /availability/venue?venue_id=1&date=2026-06-20&start=15:00&end=21:00
+
+Example screenshots:
+
+ * Weddings list: [[Image(weddings.png, width=800)]]
+ * Events list: [[Image(events.png, width=800)]]
+ * Guests list: [[Image(guests.png, width=800)]]
+ * Attendance overview: [[Image(attendance.png, width=800)]]
+ * RSVP overview: [[Image(rsvp.png, width=800)]]
+
+== Notes ==
+ * This is a prototype implementation for Phase P4.
+ * UI screens are demonstrated through REST JSON responses in browser.