Merge branch 'client-complete' of github.com:github-samples/planventure into client-complete

Author: LadyKerr

README.md

@@ -1,62 +1,124 @@
-# Planventure API 🚁
+# Planventure API Server 🚀
+
+A Flask backend API that powers the Planventure travel planning application. This guide will help you quickly get the server running so you can focus on building the client application.
+
+## Quick Start
+
+1. Fork and clone the repository:
+```sh
+git clone https://github.com/yourusername/planventure.git
+cd planventure/planventure-api
+```
+
+2. Set up Python environment and install dependencies:
+```sh
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+pip install -r requirements.txt
+```
+
+3. Start the development server:
+```sh
+flask run
+```
+
+The API server will be running at `http://localhost:5000`
+
+That's it! You can now proceed to set up and work on the client application.
+
+## API Health Check
+
+Verify the server is running:
+```sh
+curl http://localhost:5000/health
+```
+
+Expected response: `{"status": "healthy"}`
+
+# Planventure Client ✈️
 
 [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/github-samples/planventure)
 
-A Flask-based REST API backend for the Planventure application.
+A React-based travel planning application that helps you organize your trips, manage itineraries, and keep track of travel details.
+
+## Features
+
+- 🗺️ Trip Planning & Management
+- 📅 Interactive Itinerary Builder
+- 🏨 Accommodation Tracking
+- 🚗 Transportation Management
+- 📱 Responsive Design
+- 🔐 Secure Authentication
 
 ## Prerequisites
-Before you begin, ensure you have the following:
 
+Before you begin, ensure you have the following:
+- Node.js (v16 or higher)
+- npm or yarn
 - A GitHub account
 - Access to GitHub Copilot - [sign up for FREE](https://gh.io/gfb-copilot)!
-- A Code Editor
-- API Client (like [Bruno](https://github.com/usebruno/bruno))
 - Git - [Download & Install Git](https://git-scm.com/downloads)
 
 ## 🚀 Getting Started
 
-## Build along in a Codespace
+### Quick Start with Codespaces
 
-1. Click the "Open in GitHub Codespaces" button above to start developing in a GitHub Codespace.
+1. Click the "Open in GitHub Codespaces" button above
+2. Wait for the environment to build
+3. Run `npm install` and `npm run dev`
 
 ### Local Development Setup
 
-If you prefer to develop locally, follow the steps below:
-
-1. Clone the repository and navigate to the [planventue-api](/planventure-api/) directory:
+1. Open a new terminal window and cd into the `planventure-client` directory:
 ```sh
-cd planventure-api
+cd planventure/planventure-client
 ```
 
-2. Create a virtual environment and activate it:
+2. Install dependencies:
 ```sh
-python -m venv venv
-source venv/bin/activate  # On Windows: venv\Scripts\activate
+npm install
 ```
 
-3. Install the required dependencies:
+3. Create a `.env` file:
 ```sh
-pip install -r requirements.txt
+VITE_API_URL=http://localhost:5000
 ```
 
-4. Create an `.env` file based on [.sample.env](/planventure-api/.sample.env):
+4. Start the development server:
 ```sh
-cp .sample.env .env
+npm run dev
 ```
 
-5. Start the Flask development server:
-```sh
-flask run
-```
+Visit `http://localhost:5173` to see the application.
+
+## 🏗️ Tech Stack
+
+- React
+- Material-UI
+- React Router
+- Day.js
+- Vite
+
+## 📱 Features Overview
+
+### Trip Management
+- Create and manage trips
+- Set destinations and dates
+- Track accommodations and transportation
 
-## Docker Setup
+### Itinerary Planning
+- Day-by-day planning
+- Activity scheduling
+- Time management
 
-If bulding locally, follow the Docker setup steps in the [DockerSetup](DockerSetup) file.
+## 🤝 Contributing
 
-## 📚 API Endpoints
-- GET / - Welcome message
-- GET /health - Health check endpoint
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
 
 ## 📝 License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

planventure-api/requirements.txt

@@ -12,4 +12,6 @@ werkzeug==2.3.7
 bcrypt==4.0.1
 
 # Database migrations
-Flask-Migrate==4.0.5
+Flask-Migrate==4.0.5
+
+pytest==8.3.2

planventure-api/utils/test_validators.py

@@ -0,0 +1,69 @@
+import pytest
+from .validators import validate_email, validate_username
+
+def test_valid_emails():
+    """Test validation of properly formatted email addresses"""
+    valid_emails = [
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]",
+        "[email protected]"
+    ]
+    for email in valid_emails:
+        assert validate_email(email) is True
+
+def test_invalid_emails():
+    """Test validation of improperly formatted email addresses"""
+    invalid_emails = [
+        "[email protected]",
+        "@domain.com",
+        "test@domain",
+        "test@domain.",
+        "test.domain.com",
+        "test@[email protected]",
+        "test [email protected]"
+    ]
+    for email in invalid_emails:
+        assert validate_email(email) is False
+
+def test_edge_cases():
+    """Test validation with edge cases"""
+    assert validate_email("") is False
+    with pytest.raises(TypeError):
+        validate_email(None)
+
+def test_valid_usernames():
+    """Test validation of properly formatted usernames"""
+    valid_usernames = [
+        "user123",
+        "_user",
+        "john_doe",
+        "a123",
+        "Developer42",
+        "code_master",
+        "Alice_Bob_123"
+    ]
+    for username in valid_usernames:
+        assert validate_username(username) is True
+
+def test_invalid_usernames():
+    """Test validation of improperly formatted usernames"""
+    invalid_usernames = [
+        "ab",  # too short
+        "a" * 17,  # too long
+        "123user",  # starts with number
+        "__user",  # multiple underscores at start
+        "user name",  # contains space
+        "user@name",  # special character
+        "-user",  # starts with hyphen
+        "user-",  # ends with hyphen
+    ]
+    for username in invalid_usernames:
+        assert validate_username(username) is False
+
+def test_username_edge_cases():
+    """Test username validation with edge cases"""
+    assert validate_username("") is False
+    with pytest.raises(TypeError):
+        validate_username(None)

planventure-api/utils/validators.py

@@ -4,3 +4,42 @@ def validate_email(email: str) -> bool:
     """Validate email format using regex pattern"""
     pattern = r'^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$'
     return bool(re.match(pattern, email))
+
+def validate_username(username: str) -> bool:
+    """
+    Validates a username according to the following rules:
+    - Between 3 and 16 characters
+    - Starts with a letter or single underscore
+    - Can contain letters, numbers, and underscores after first character
+    - No spaces or special characters
+    
+    Args:
+        username: The username to validate
+        
+    Returns:
+        bool: True if username is valid, False otherwise
+        
+    Raises:
+        TypeError: If username is None
+    """
+    if username is None:
+        raise TypeError("Username cannot be None")
+        
+    # Check for empty string
+    if not username:
+        return False
+        
+    # Check length (3-16 characters)
+    if len(username) < 3 or len(username) > 16:
+        return False
+        
+    # Pattern explanation:
+    # ^            - Start of string
+    # [a-zA-Z_]    - First character must be letter or underscore
+    # (?!_)        - Negative lookahead to prevent multiple underscores at start
+    # [a-zA-Z0-9_] - Remaining characters can be letters, numbers, or underscores
+    # {2,15}       - Length of remaining characters (2-15, plus first character = 3-16 total)
+    # $            - End of string
+    pattern = r'^[a-zA-Z_](?!_)[a-zA-Z0-9_]{2,15}$'
+    
+    return bool(re.match(pattern, username))

planventure-client/package.json

@@ -14,8 +14,7 @@
     "@emotion/styled": "^11.14.0",
     "@mui/icons-material": "^6.2.0",
     "@mui/material": "^6.2.0",
-    "@mui/x-date-pickers": "^7.27.1",
-    "dayjs": "^1.11.13",
+    "@mui/icons-material": "^6.2.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-router-dom": "^7.0.2"