BIL_495_FINAL

BIL_495_FINAL

gezBot API Documentation

Overview

The gezBot API is a FastAPI application integrated with Firebase Firestore and Firebase Authentication. It's designed for managing social interactions and travel planning in a social travel application.

Getting Started

Prerequisites

• Python 3.6+
• FastAPI
• Uvicorn (or any ASGI server)
• Firebase Admin SDK

Installation

1. Clone the repository:

   git clone [repository_url]

2. Install the required packages:

   pip install -r requirements.txt

Setting up Firebase

1. Set up a Firebase project.
2. Generate and download your Firebase Admin SDK service account key.
3. Initialize your firebase_config.py with your Firebase credentials.

Running the Application

Run the application using Uvicorn:

uvicorn main:app --reload

Features

User Management

• User Registration: POST /register
• Retrieve User: GET /users/{user_id}

Friend Management

• Send Friend Request: POST /send_friend_request/{sender_id}/{receiver_id}
• Accept Friend Request: POST /accept_friend_request/{request_id}/{sender_id}/{receiver_id}

Travel Planning

• Create Travel Plan: POST /travels
• Get Travel Plans: GET /travels

Chat Functionality

• Add Chat Message: POST /chats/{travel_id}/message
• Get Chat Messages: GET /chats/{travel_id}/messages

User Preferences

• Add User Options: POST /userOptions/{user_id}/{travel_id}
• Get User Options: GET /userOptions/{travel_id}

Error Handling

The API provides detailed error messages and appropriate HTTP status codes for various scenarios like invalid requests or server errors.

Security

User authentication and data security are handled using Firebase Authentication.

Scalability

Designed to be scalable, accommodating an increasing number of users and data transactions seamlessly.

Dependencies

List of dependencies can be found in requirements.txt.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

This README provides a basic guide to getting the API up and running. For more detailed documentation, see the API routes and models within the codebase.